1. Sales or account manager should request API credentials & tenant for stage on the customer behalf.

A venue on stage must exist and should be configured to match the needed use cases. Ask your account manager or the global support team to create the environment

2. Once granted, the customer can start developing, see below Best Practices recommendations for development

3. Once development is completed, please send the architecture by email for a review by the api team - api-support@pixellot.tv

5. Detailed architecture diagram. Example of such a diagram:
   

Diagram can omit the platform or framework names (e.g. “Oracle SQL 19c running on 3 nodes”). But should provide information on which component actually calls the Pixellot API, what are the expected APIs to be utilized, and more relevant information about the integration itself.

4. Once architecture is approved sales or account manager can request the prod credentials on the customer behalf.

5. Sales or account manager configures the needed tenant or club-level options, such as streaming settings, or feature flags.

** Notes for step 3 - Our experience shows that certain implementations tend to expose integrations to issues later, the architecture review is meant for us to avoid such cases and make sure your implementation is scalable once you grow

Best practices

1. Once you login with the username & pass you get a token, the token is valid for 10 hours after which you will need to renew. It is not needed to use a fresh token for each request.
2. 10 minutes before the event start$date we start automatic process for the live stream. From this point on no changes can be made to the event start$date 
   
3. Instead of fetching events, teams, or venues to refresh the saved lists of them, Webhook Subscriptions should be used, such as the one for team changes - API Integration - Events Monitoring and Hooks.
4. If you want to finish event early (before the original scheduled time) change the update the end$date to now+1 minute.
5. If you wish to get details on event changes, URLs, system changes and more - please do a Webhook Subscription as described in the:   API Integration - Events Monitoring and Hooks document.
6. Follow the provided payload schemas for create and update operations - see which fields are required, and what their recommended format is.
   
   

Contact us by api-support@pixellot.tv in case of API questions. Venue installation, club setup, or credentials are not managed by API Support, but by the account managers and a global support team.

When contacting the API support in regards to failed requests it is important to provide the following details - 

1. The endpoint you made the request to - please remove any sensitive information like tokens and passwords.
2. The body of the request.
3. The response you received.
   

Recommended, but not required:

4. The timestamp (or time range) when you sent the request, and related events IDs.
   
5. “X-Request-ID” header from the response headers.