Bellhop API Documentation
Obtain a token
POST {{HOST}}/api/partner-api/authorize
Obtain a JWT token with the provided credentials. Caching Available Scopes Note: Scopes
All tokens are cached for 86400 seconds (24 hours) on our server, feel free to call the API as many times as you need.
Scopes are attached to a token, and are cached. Any scope changes will take 24 hours to update.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImM5akc0YkVjOTZfeTVIODFjdlY3VyJ9.eyJodHRwczovL2JlbGxob3AuY29tOm93bmVyIjoiUGFydG5lciBBUEkgKFRlc3QgQXBwbGljYXRpb24pIiwiaXNzIjoiaHR0cHM6Ly9iZWxsaG9wLWRldmVsb3BtZW50LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiIyMHBSYmVNSmhDWDh6UUwzTFV1Ym5xTXNmdjAyMXVTSEBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9wYXJ0bmVycy5iZWxsaG9wcy5kZXYiLCJpYXQiOjE2Mzg4OTIwNzIsImV4cCI6MTYzODk3ODQ3MiwiYXpwIjoiMjBwUmJlTUpoQ1g4elFMM0xVdWJucU1zZnYwMjF1U0giLCJzY29wZSI6InNhbGVzOmxlYWRzOmNyZWF0ZSBzYWxlczpsZWFkczp2aWV3IiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.b4fq_FE4G1IfWa207sDrKrtdmLqP3DItZpUwinZtUV-RO6qVEwgMbyBAXVHtvuTc2GwEZNaF-kSG9FMSVMFAzWi5IApoW5E8GBRJ2ca1Jvl0c0a0ne65uLjR4xWZkXshC2qWQ9Mp_I25LUvyrNfLzNlbJ5LrEtDuVwjoihkZlmUBmmghUau3sOM2Y1bt0RUlXyec5asL8pjJepP97ZAW04LwSCaF_RTfthkRnUPI0wLx29LpDFj8PLw0ew3IlFKm14R1ey014O3yibIvzkAv4Vpk6wF0mAWVk-fHyRmOPY8FHFEv4USmUey0fYHmy-1f5jyVGBqY5nvMvQIF9jKnpA"
} |
Curl
curl -X POST 'HOST/api/partner-api/authorize' -d '{"grant_type":"client_credentials","clientId":"OAUTH_CLIENT_ID","clientSecret":"OAUTH_CLIENT_SECRET","audience":"OAUTH_AUDIENCE"}'
ENDPOINTS