Developer Portal usage

Access documentation on Developer Portal

In order to access documentation and get credential to call APIs, developers must sign-up to this portal. The process in details:

  1. Sign up to developer portal with your first name, last name, email and the password you prefer;

  2. Click the account activation link in the email you've just received;

  3. Sign in to developer portal to access Products and APIs documentation.

Get product Subscription Keys to call a product API

A Product contains one or more APIs. You need to subscribe the Product to get subscription keys needed to call product APIs.

  1. Select a Product from the list and enter the details page;

  2. In "Your subscriptions" section, fill "Your new product subscription name" and click "Subscribe";

    Tip: name your subscription like the app or the marketplace that will use one of the Product APIs. E.g. MyConnectorApp, LuxuryMarketplace, etc.

  3. Developer portal admins will approve your subscription request;

  4. After approval in your Profile page you find the list of all your active Product subscriptions. You can rename/cancel subscriptions and show/regenerate keys.

Call an API with an active Subscription Key

To call an API you need to provide an active Subscription Key to identify you. Add an "Ocp-Apim-Subscription-Key" header to any calls.

  • Developer Portal "Try it" page:

    1. Select an API from the list and enter documentation page;

    2. Select an operation from the list anche click "Try it" button;

    3. In "Authorization" section pick a "Subscription Key" from the drop-down list. In the "Header" section the header "Ocp-Apim-Subscription-Key" will changes accordingly;

    4. Complete "Parameters" section with required and optional parameter and click "Send" button to try the API request.

  • REST client applications (e.g. your app, Postman, etc):

    • Add to all your request the header "Ocp-Apim-Subscription-Key" passing an active product Subscription Key from your Profile.

APIs additional required parameters: client, apiKey, Bearer tokens, etc

Some of our APIs need additional parameters and security tokens, i.e:

  • <client>: static value provided by our support team;

  • <apiKey>: static key provided by our support team;

  • Bearer token authentication:

    1. API exposes a "/tokens" operation: post your credentials to receive an authentication token. Credentials are provided by out support team during setup procedure.

    2. Pass the authentication token you get to other API operations: add an "Authorization" header with value "Bearer <token>" to all requests.

      Note: default tokens expire after 20 minutes.

APIs usage policy

We strongly invite you to access the Dresscode API Developer Portal with your account and check the statistics about your Subscription Key in the "Reports" section, in particular, the number of daily synchronizations and the amount of data transferred via API.

To ensure the correct functioning of the service, it's essential that all users comply with the basic guidelines, illustrated in the PDF downloadable from the "Help -> DC.Channels API Best Practices" menu.

We inform you that new restrictive policies will soon be introduced with the aim of regulating the correct usage of the Dresscode APIs. 

These may involve limits on the number of calls per day as well as the amount of data transferred to and from the APIs.
You are therefore invited to correct the synchronization mode with the Dresscode API as soon as possible, limiting the number of queries and optimizing massive queries ALWAYS specifying the "from" parameter (see technical details on the developer portal).