Getting Started with the Developer Portal

1. Sign Up and Subscribe

  1. Create an Account: Navigate to the developer portal and click "Sign Up" to create your developer account

  2. Browse APIs: Explore available APIs in the API catalog to understand capabilities

  3. Subscribe to a Product: Choose a subscription product that matches your business needs (see products below)

  4. Get Your Subscription Key: After subscribing, retrieve your subscription key from the "Profile" section

2. Testing APIs in Sandbox

All API subscriptions provide access to a sandbox environment for testing and development:

  • Starter Subscription is ideal for initial testing and evaluation

  • Sandbox returns mock responses with realistic data structures

  • No backend systems are affected during sandbox testing

  • Perfect for developing and debugging your integration code

3. Making API Calls

Include your subscription key in every API request using one of these methods:

Method 1: Request Header (Recommended)

GET https://apim-signify-demo.azure-api.net/catalog/v1/products Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

Method 2: Query Parameter

GET https://apim-signify-demo.azure-api.net/catalog/v1/products?subscription-key=YOUR_SUBSCRIPTION_KEY

4. Using the API Console

The developer portal includes an interactive API Console for each operation:

  1. Navigate to any API operation page

  2. Click "Try it" to open the interactive console

  3. Enter required parameters

  4. Your subscription key is automatically included

  5. Click "Send" to execute the request

  6. View the response, status code, and headers in real-time

Subscription Products

Starter (Sandbox Testing)

Purpose: Evaluation and sandbox testing for all developers

Rate Limits:

  • 5 calls per minute

  • Maximum 100 calls per week

Included APIs:

  • Product Catalog API

  • Order Management API

  • Shipment Tracking API

  • Invoicing API

  • Partner Onboarding API

Best For:

  • Initial API evaluation and proof-of-concept development

  • Learning API structures and response formats

  • Testing integration code against sandbox mock responses

  • Developer training and onboarding

How to Use:

  1. Subscribe to the "Starter" product in the developer portal

  2. Use your Starter subscription key for all sandbox API calls

  3. Test all operations across all five APIs

  4. Develop and debug your integration code

  5. When ready for production, upgrade to a production subscription (Resellers or Installers)

Resellers

Purpose: Product information distribution for e-commerce and digital platforms

Target Audience: Distributors, wholesalers, and resellers who need to display Signify product information on their own websites, mobile apps, or e-commerce platforms

Included APIs:

  • Product Catalog API - Full access to product discovery and pricing

Key Capabilities:

  • Browse products by category (lighting, controls, accessories)

  • Search products by keyword or SKU

  • Retrieve detailed product specifications and technical attributes

  • Access account-specific pricing for quote generation

  • Support product feeds for e-commerce integrations

Use Cases:

  • E-Commerce Integration: Display Signify products on reseller e-commerce websites

  • Product Feed Generation: Export product data to marketplaces (Amazon, eBay, etc.)

  • Quote Systems: Generate customer quotes with account-specific pricing

  • Mobile Apps: Power product discovery in reseller mobile applications

  • Catalog Synchronization: Keep product information up-to-date across multiple platforms

API Operations:

  • GET /products - List products with filtering by category and search

  • GET /products/{sku} - Retrieve detailed specifications for a single product

  • GET /price-lists/{accountId} - Get account-specific pricing

Getting Started:

  1. Subscribe to the "Resellers" product

  2. Integrate the Product Catalog API into your e-commerce or digital platform

  3. Use product discovery operations to populate your catalog

  4. Retrieve account-specific pricing for quote generation

  5. Implement regular synchronization to keep product data current

Installers

Purpose: Complete operational API access for order submission, tracking, and lifecycle management

Target Audience: Electrical contractors, installers, and service providers who need to manage the complete order-to-invoice lifecycle through API integration

Included APIs:

  • Product Catalog API - Product discovery and pricing

  • Order Management API - Submit and track orders

  • Shipment Tracking API - Monitor shipments and delivery

  • Invoicing API - Retrieve invoices and submit payments

Key Capabilities:

Order Management

  • Submit purchase orders programmatically from installer management systems

  • Track order status and fulfillment progress

  • Cancel orders before shipment cut-off

  • Automated order confirmations and status updates

Shipment Tracking

  • Real-time visibility into shipment status and ETAs

  • Access chronological tracking events

  • Retrieve proof of delivery documents

  • Proactive exception monitoring

Accounts Payable Automation

  • Retrieve open invoices for accounting workflows

  • Submit payment confirmations for reconciliation

  • Monitor invoice status and aging

  • Export invoice data to ERP systems

Use Cases:

  • ERP Integration: Connect Signify APIs to contractor management software (Sage, QuickBooks, SAP)

  • Job Management: Automated ordering based on project requirements and schedules

  • Customer Portals: Provide end customers with real-time project status and delivery tracking

  • Accounts Payable: Automate invoice retrieval and payment processing

  • Mobile Workforce: Enable field technicians to check order status and delivery ETAs

API Operations:

Product Catalog:

  • GET /products - Browse and search products

  • GET /products/{sku} - Product specifications

  • GET /price-lists/{accountId} - Account pricing

Orders:

  • POST /orders - Submit new orders

  • GET /orders/{orderId} - Check order status

  • POST /orders/{orderId}/cancel - Cancel orders

Shipments:

  • GET /shipments/{shipmentId} - Shipment status and ETA

  • GET /shipments/{shipmentId}/events - Tracking timeline

  • GET /shipments/{shipmentId}/proof-of-delivery - Delivery confirmation

Invoicing:

  • GET /invoices?partnerId={id} - List invoices

  • GET /invoices/{invoiceId} - Invoice details

  • POST /invoices/{invoiceId}/payments - Register payments

Getting Started:

  1. Subscribe to the "Installers" product

  2. Test integration using Starter subscription in sandbox first

  3. Integrate with your contractor management or ERP system

  4. Implement order submission workflow

  5. Set up shipment tracking and customer notifications

  6. Automate invoice retrieval for accounts payable

API Integration Best Practices

Authentication

  • Keep subscription keys secure - never commit to source control

  • Rotate keys periodically for security

  • Use separate keys for sandbox vs production environments

Error Handling

  • Always check HTTP status codes (200, 201, 400, 401, 404, 422)

  • Implement retry logic for transient failures (500, 503)

  • Log error responses for troubleshooting

Rate Limiting

  • Respect rate limits in your subscription product

  • Implement exponential backoff for rate limit responses (429)

  • Consider caching frequently accessed data (product catalogs)

Data Validation

  • Validate SKUs before submitting orders

  • Check price list validity dates before quoting

  • Verify order status before attempting cancellations

Support and Resources

Documentation

  • API Reference: Detailed operation documentation with request/response examples

  • Schema Definitions: Complete data model reference for all objects

  • Code Samples: Example implementations in multiple languages

Testing Tools

  • API Console: Interactive testing directly in the developer portal

  • Sandbox Environment: Safe testing with mock data

  • Postman Collection: Import API operations into Postman (available on request)

Getting Help

  • Technical Support: Contact API support through the developer portal

  • Community Forum: Connect with other developers and share integration patterns

  • Status Page: Monitor API availability and planned maintenance

Next Steps

  1. Subscribe to Starter - Begin testing with the Starter subscription

  2. Explore the APIs - Use the API Console to try different operations

  3. Build Your Integration - Develop against the sandbox environment

  4. Choose Your Product - Upgrade to Resellers or Installers based on your needs

  5. Go to Production - Deploy your integration with confidence

Welcome to the Signify B2B API ecosystem!