We are a company with the goal of making reward programs accessible to all businesses. Through our unique platform, we aim to enhance the satisfaction of your team, collaborators, and customers with a simple, agile, and innovative management solution.
\nThis is the official Incent API documentation.
\nTo ensure the security and privacy of your data, our API requires authentication for every request. Authentication is performed by including a token in the header of your request. This ensures that only authorized users can access the resources of the Incent.
\nLogin: Access your account on the Incent: https://app.incent.mx
\nNavigate to API Tokens: Go to the “API Tokens” section in your user profile.
\nCreate Token: Click on “Create New Token” and provide a name for the token and set the permissions.
\nSave Token: After creation, your new API token will be displayed. Copy and store it securely, as it will only be shown once.
\nInclude in Headers: For each API request, include your token in the request headers.
\nHeader Format: Use the following format:
Authorization: Bearer YOUR_API_TOKEN
Make Requests: Ensure the token is sent with every API request to authenticate and access the resources securely.
\nStaging: https://staging.app.incent.mx
\nProduction: https://app.incent.mx
\nRetrieve a list of GiftCards with details.
\nParameters:
\nRetrieve details of a specific GiftCard.
\nParameters:
\nCreate a new GiftCard with the specified details.
\nParameters:
\nname: string, optional. The name of the recipient. Example: John
\nlastname: string, optional. The lastname of the recipient. Example: Doe
\nmobile: string, optional. The mobile number of the recipient. Example: 1234567890
\nemail: string, optional. The email of the recipient. Example: john@example.com
\nsupplier_code: string, required. Check your dashboard to find the allowed suppliers and their associated products. Example: amazon_mx
\nproduct_sku: string, required. Check your dashboard to find the allowed suppliers and their associated products. Example: gc-amazon-mx
\namount: integer, required. Check your dashboard to find the minimum and maximum amounts for each supplier. Example: 1000
\ncampaign_id: integer, required. The campaign ID associated with the GiftCard. Example: 1
\nnotes: string, optional. Any notes for the GiftCard. Example: Notes here
\nThe Gift Cards folder contains endpoints for managing gift cards within the Gift App. These endpoints allow you to create, list, and retrieve detailed information about gift cards.
\n","_postman_id":"dbd14a0b-3617-407d-b634-9bb384f31cff","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c5ff5d59-99d0-4c35-b557-07c92a628b3b","id":"c5ff5d59-99d0-4c35-b557-07c92a628b3b","name":"Incent API (v1)","type":"collection"}}},{"name":"Campaigns","item":[{"name":"List Campaigns","event":[{"listen":"test","script":{"id":"0003f6d6-6583-4148-a194-b15e0665a359","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"e7d7bec3-333d-4890-acf7-9ef41bb72aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"active\",\n \"per_page\": 1\n\n}","options":{"raw":{"language":"json"}}},"url":"https://app.incent.mx/api/v1/campaigns","description":"Retrieve a list of campaigns with specific filters.
\nParameters:
\nstatus: string, optional. Filter by status of the campaign. Allowed values: active, inactive. Example: active
\nper_page: integer, optional. Number of results per page. Minimum: 1, Maximum: 50. Example: 10
\nRetrieve details of a specific campaign.
\nParameters:
\nCreate a new campaign with the specified details.
\nParameters:
\nUpdate an existing campaign with the specified details.
\nParameters:
\nid: integer, required. The ID of the campaign to update. Example: 1
\nname: string, optional. The name of the campaign. Example: Campaign 109 Updated
\ndescription: string, optional. The description of the campaign. Example: Updated description
\nstart_date: date, optional. The start date of the campaign. Example: 2024-11-12
\nend_date: date, optional. The end date of the campaign. Example: 2024-11-13
\nThe Campaigns folder contains endpoints for managing campaigns within the Gift App. These endpoints allow you to list, create, update, and retrieve detailed information about campaigns.
\n","_postman_id":"9cdce8dd-fff7-4370-bd7e-352e24cc8a83","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c5ff5d59-99d0-4c35-b557-07c92a628b3b","id":"c5ff5d59-99d0-4c35-b557-07c92a628b3b","name":"Incent API (v1)","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"dd92d855-2a30-45fd-a51f-ac2b738c5279","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a4134d4-2eab-4222-b704-29a83d04bea8","type":"text/javascript","exec":[""]}}],"variable":[{"key":"id","value":"1"},{"key":"base_url","value":"https://app.incent.mx"},{"key":"version","value":"v1","type":"string"},{"key":"auth_key","value":"","type":"string"}]}