🔐 Authentication

📘

Auth Scheme is based on your token type

[api] is used for certificate-based authentication

[api-token] is used for token-based authentication

[partner-api-token] is used for Partner Webservices

[partner-api] is used for Partner Webservices

The Rhombus API provides two methods for authentication, certificate-based and token-based. We strongly encourage customers to use the certificate-based approach, as it offers an overall more secure interaction. Whereas the token-based approach is typically easier to get up and running quickly. Both approaches utilize an “apikey”, and the following HTTP headers should be sent with every request:

x-auth-scheme: [api]* or [api-token]* or [partner-api-token]*
x-auth-apikey: XXXXXXXXXXXX


Client Example:
x-auth-scheme: api-token
x-auth-apikey: XXXXXXXXXXXXXXX

Partner Example:
x-auth-scheme: partner-api-token
x-auth-apikey: XXXXXXXXXXXXXXXX
x-auth-org: client_org

The [brackets] are not required in the request