Hike Public API
Hike POS public integration API.
Authentication. Obtain a bearer token from POST /oauth/token (application/x-www-form-urlencoded), then call the /api/v1/* endpoints with the header Authorization: Bearer <access_token>.
Grant types: client_credentials, refresh_token, authorization_code. Send client_id and client_secret either as HTTP Basic credentials or as form fields. client_credentials additionally takes storename (your tenancy name or id) and user_id.
Responses carry access_token, token_type, expires_in and refresh_token; a failure is {"error":"..."} with status 400. Re-authenticate on HTTP 401.
Rate limits. Calls are limited per integration. Exceeding one returns HTTP 429 with a Retry-After header and a message naming the window that was exhausted.
Authentication
- OAuth 2.0: HikeOAuth2
- HTTP: Bearer Auth
OAuth 2.0 authorization code flow. Register an app at https://developer.hikeup.com to get an App Id and App Secret. Access tokens are sent as Authorization: Bearer <access_token>.
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (authorizationCode): | Token URL: https://api.hikeup.com/oauth/token Authorization URL: https://api.hikeup.com/oauth/authorize Refresh URL: https://api.hikeup.com/oauth/token Scopes:
|
An access token from POST https://api.hikeup.com/oauth/token.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |