Contents x
    /Authorization
    • 17 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /Authorization

    • Updated on 17 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /Authorization

    Description

    With the Authorization API, you can retrieve valid authentication credentials for the other APIs. 

    Use Case

    To ensure secure and continuous access to the Bloxs API, users must obtain valid authorization details regularly. The token you receive remains valid for 24 hours.           

    FieldDescription
    apiKeyThis is the user's personal key to access the API. You can create it by logging into the Bloxs environment and going to your User Profile.
    apiSecretThis is the client environment key. You can retrieve or renew it in the Bloxs environment under Admin -> Integrations -> API.
    token

    This is the value that must be included in the Authorization header for the API calls. The HTTP Header should look like this:

    Authorization: Bearer {Token}

    expirationThis is the validity period of the token, currently 24 hours. After that, a new token must be obtained.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    object
    apiKey
    string Required
    Min length1
    apiSecret
    string Required
    Min length1
    Responses
    200

    The authorization token created

    object
    token
    string | null
    expiration
    string (date-time)
    400

    The authorization token can't be created

    What's Next