Welcome to the Bederr API! You can use our API to access Bederr API endpoints, which can get information on various companies, programs, promotions, and places in our database.
\nWe have language bindings in Shell! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
\nThis example API documentation page was created with Slate. Feel free to edit it and use it as a base for your own API's documentation.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18369525","collectionId":"1e18fb30-b392-4f3c-a8c7-c68b1fa588ea","publishedId":"UVR8pTdZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"17bc9b"},"publishDate":"2022-09-27T16:05:04.000Z"},"item":[{"name":"Authentication","item":[{"name":"Getting the Access Token","event":[{"listen":"prerequest","script":{"id":"411246f4-2233-482f-97df-24de7d8cf40f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"ec479a89-335d-4975-a33e-d0140d87bcdf","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.access_token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ff0d522a-460f-4362-abad-da4c07339e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"}]},"url":"{{URL}}v6/oauth2/token/","description":"Once your application has completed the above section and gotten and authorization code, it'll now need to exchange the authorization code for an access token from Bederr API.
\nIt is used to obtain an access token outside of the context of a user.
\nThis is typically used by clients to access resources about themselves rather than to access a user's resources.
\nThe access_token is the actual string needed to make API requests. Each access_token is valid for 1 hour. Once you have a valid access_token, you can use it to make requests to the BEDERR API. All you need to do is set it in the Authorization header like this:
Authorization: Bearer {a valid access token}
For example, you can get the authenticated member basic info accesing the /me endpoint.
Apps connect to Bederr API using OAuth 2.0, the standard used by most APIs for authenticating and authorizing users. The following walkthrough will show you how to authenticate and get user authorization to access the required data.
\nAdditionally there are client libraries available in a number of languages that you might find useful.
\nBefore you can start using OAuth 2.0 with your application you'll need to tell Bederr a bit of information about you application.
\nWe will give you in return: 1. Your client id 2. Your client secret 3. The type of Oauth grant you will need to authenticate in our API. 4. A list of scopes available for you.
\n","_postman_id":"9af83320-8e07-4341-b02c-fb11d379894e"},{"name":"Companies","item":[{"name":"List companies with promotions","event":[{"listen":"test","script":{"id":"fca36e0b-3d33-411f-af4c-f2146cde8e2d","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"external_company_uid\", jsonData.results[0].uid);"],"type":"text/javascript"}}],"id":"083189ec-cef4-4331-bf5c-b67abba92a35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}v6/admin/programs/{{program_uid}}/companies/","description":"Attribute extra:
\nAttribute Employee Object:
\nAttribute extra:
\nAttribute extra:
\nAttribute Employee Object:
\nAttribute extra:
\nList all the programs of a company.
\nThis endpoint returns an array of the following object:
\nPrograms are the main level of our API.
\n","_postman_id":"6897df16-5a69-4148-a856-5bf237bc2846"},{"name":"Promotions","item":[{"name":"List promotions","event":[{"listen":"test","script":{"id":"a6c7c197-c820-4d49-a55c-1501e311be90","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"promotion_uid\", jsonData.results[0].uid);"],"type":"text/javascript","packages":{}}}],"id":"0a214291-3757-4acc-bbc9-1de065d49f8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Test Promotion 50% mayo\",\r\n \"image\": \"https://bederr-supernova.s3.amazonaws.com/media/promotions/20250203125638_3e9293ecfb1246efb6e922c5d89d6cba.png\",\r\n \"company_retail\": {\r\n \"uid\": \"kXxNvk\",\r\n \"name\": \"CompanyBederrTest\",\r\n \"web_page\": \"\",\r\n \"facebook_page\": \"\",\r\n \"logo\": \"https://bederr-supernova.s3.amazonaws.com/media/companies/logo_photos/20250512103915_03cc00f2040346a896b754c5141f1af3.png\",\r\n \"cover\": null,\r\n \"logo_rectangle\": null,\r\n \"description\": \"\"\r\n },\r\n \"pin\": null,\r\n \"rate_discount\": 50,\r\n \"is_transferable\": true,\r\n \"sections\": [\r\n {\r\n \"uid\": \"9AZJ48\",\r\n \"name\": \"General\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}v6/admin/programs/{{program_uid}}/promotions/","description":"-Company_JSON
\n-Pin_JSON
\n-Section_JSON
\n-Company_JSON
\n-Pin_JSON
\n-Section_JSON
\n\n\n⚠️ Note:
\n
- Use `rate_discount` only if `type` is `RATE`.
- Use `fixed_discount` only if `type` is `FIXED`.
-Company_JSON
\n-Pin_JSON
\n-Section_JSON
\n\n\n⚠️ Note:
\n
- Use `rate_discount` only if `type` is `RATE`.
- Use `fixed_discount` only if `type` is `FIXED`.
-Company_JSON
\n-Pin_JSON
\n-Section_JSON
\n-Company_JSON
\n-Pin_JSON
\n-Section_JSON
\n-Company_JSON
\n-Section_JSON
\n-Segment_JSON
\n-Place_JSON
\n-Pin_JSON
\nDIGITAL_PRODUCT)ORDER)PROGRAM_PROMOTION)MEMBER)List all segments of a program.
\nRetrieve segment for a given program.
\n