See below for the steps on API integration on Line-Up
KEY TERMS & TIPS:
What is an API?
It is a series of URLs that relate to data, which is how third-party agents can access our software.
How do agents connect to the Line-Up API?
The agent will need to have an existing integration with the Line-Up API. If they are not yet integrated but would like to, please ask them to contact support@lineupnow.com.
Once an agent has integrated with the Line-Up API, to give them access to your event data, you will need to set-up a Channel for them and give that Channel the appropriate access to the event[s], performances and pricing data.
When the Channel is set-up, we will let you know the API Key for that channel. This is a token which allows them to see the data you give that Channel access to.
What details do I need to provide?
What they will be using the API for, contact details for the agent and their channel ID.
See our Step-by-Step guide below for more info.
Do you have API docs for third-party agents?
Yes, via our website, on this page.
What should the agent do if they're having issues with the API?
They should contact us directly via our Slack community channel. See below for details about this.
---
STEP-BY-STEP GUIDE:
1. Contact us with details
a) If a third-party agent would like to integrate with us, please contact us with the following details:
- Agent name
- What they would like to use our API for
- Email address of the main contact - so we can add them to our Slack community channel
b) This is not only for security purposes but also because they may have integrated with us already, in which case we can point them towards the correct channels.
2. Create a Channel
a) If the agent has already integrated with the Line-UP API / once they have done so, then please create a Channel for them and then let us know the Channel ID. You can find this at the end of the URL of their Channel page:
b) We will then create an API Key for this Channel and will send it to you when ready.
3. Is the agent charging commission on sales?
a) If yes, create an Inside Adjuster and add their Channel to it
b) You'll then need to do add this to your Event's Price Table. For more info on Adjusters, go here
4. Add to Payment Method
a) Either create a new Custom Payment Method for agent sales/invoices and add the new agent channel to it
b) Or add the Channel to an existing Payment Method. For more info on Payment Methods, go here.
5. Add to Delivery Method
a) Either create a new Delivery Method for agents and add the new agent channel to it
b) Or add the channel to an existing Delivery Method. For more info on Delivery Methods, go here
6. Channel Access
a) Add their Channel to the correct performances and prices on the Event pages
b) When you are ready for the agent to have access, add the channel to the Event Info page. See here for more info about Channel access
7. API Key
a) Once this is ready, send it to the agent
b) They will then be able to see the data you have given their Channel access to
8. Any issues with their API access?
a) Please ask them to contact us on the Slack community
b) Our dev team will then be able to provide assistance
Comments
0 comments
Please sign in to leave a comment.