This REST API would be used to interact with NodiRef's Referral Engine, in order to interact with the routes, you will need to authenticate your requests, see the Authentication section on this documentation so you understand how to use it.
\nWith this API, you will be able to interact with all the resources from the Referral Management System programatically, the main idea of NodiRef, is that it can act like any other service in your back-end, to manage your partners, referral links and rewards, this way you can offload all the complexity of your reward system to us, and you can handle your main business logic.
\nIn order to be able to interact with private endpoints of this API, you will need a API Token that you can get from your profile in the Back-Office. Once you get your token, you can use it like a Bearer Token in all your requests, so we can authenticate you. You can use it as follows:
\nAuthorization: Bearer YOUR_TOKEN_HERE\n\nQuery Param: filter[filter_name]=filter_value
In our API, we follow a very simple principle that applies to Filters, Sorts, Pagination and other operation types, which as adding a query parameter with the type of operation, the field that's used and the value, for example:
\nGET https://api.nodiref.com/partners?filter[external_id]=MyExternalId\n\nAnd internally we will detect it and perform a filter on your request to get the results you are looking for. Typically on every resource you will have a list of filterable fields that you can use.
\nFor the pagination, you will have different options that you could use, similar to the filters, we use an operation query param, which is page, and we set the options we want, for example:
\nNormally you would choose wether you use page and item_per_page or page[number] and page[size], we gave you both possibilities and it's up to you to choose which one you are more comfortable using.
If you want to have extra information on your list, you can include some information that's related to the resource you are querying, for instance, maybe if you are querying the Partners list, you would want to have the Project information whose Partner belong to, you can do this by including the includes query parameter into your request, and selecting the available relationship. You can concatenate the includes by separating them with a comma if you need to add more than one. For example:
GET https://api.nodiref.com/partners?include=project\n\nTo have the available fields, you can check in the requests directly, it will be marked there.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38948109","collectionId":"073dc2c1-fe54-4854-8020-bae53a3edb49","publishedId":"2sB34kEeDp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7E5BF6"},"publishDate":"2025-07-20T13:11:07.000Z"},"item":[{"name":"Referral","item":[{"name":"Partners","item":[{"name":"Balance","item":[{"name":"/partners/{id}/balance/available","id":"e307805f-873c-4fb8-9e02-47acbda0ea7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/partners/:partner_id/balance/available","description":"This endpoint will return the available balance for this partner, this balance is already approved and ready to be used or withdrawed by the partner, depending on your business logic.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["partners",":partner_id","balance","available"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"description":{"content":"The Partner's ID or external ID
\n","type":"text/plain"},"type":"any","value":"","key":"partner_id"}]}},"response":[{"id":"40a47c1e-bd1a-4864-bcac-0373792f53ce","name":"Available balance","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nodiref.com/partners/:partner_id/balance/available","host":["https://api.nodiref.com"],"path":["partners",":partner_id","balance","available"],"variable":[{"key":"partner_id","value":"9f6f566d-01d7-4c69-9201-2da505d573a4","description":"The Partner's ID or external ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8008"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 27 Jul 2025 10:43:48 GMT"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Caddy"},{"key":"X-Powered-By","value":"PHP/8.4.10"},{"key":"Content-Length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"type\": \"currency\",\n \"balance\": \"100.00\"\n }\n ]\n}"},{"id":"84cbca08-6a93-45b9-94ed-0c362c5445cd","name":"No balance available","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nodiref.com/partners/:partner_id/balance/available","host":["https://api.nodiref.com"],"path":["partners",":partner_id","balance","available"],"variable":[{"key":"partner_id","value":"9f6f566d-01d7-4c69-9201-2da505d573a4","description":"The Partner's ID or external ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8008"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 27 Jul 2025 10:46:10 GMT"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Caddy"},{"key":"X-Powered-By","value":"PHP/8.4.10"},{"key":"Content-Length","value":"26"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": []\n}"}],"_postman_id":"e307805f-873c-4fb8-9e02-47acbda0ea7a"},{"name":"/partners/{id}/balance/pending","id":"4d700e41-1378-49d7-a43a-235e95e7fe0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/partners/:partner_id/balance/pending","description":"This endpoint will return the pending balance for this partner, this balance is not yet approved. The amount showed here is the amount of the computed rewards of the accepted conversions that are pending to be accepted or rejected.
\nWhen a conversion gets accepted, it will go directly to the available balance and get discounted from the pending balance.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["partners",":partner_id","balance","pending"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"description":{"content":"The Partner's ID or external ID
\n","type":"text/plain"},"type":"any","value":"","key":"partner_id"}]}},"response":[{"id":"7e8eca97-d110-4657-945f-ca58eea0c81b","name":"Balance available","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nodiref.com/partners/:partner_id/balance/pending","host":["https://api.nodiref.com"],"path":["partners",":partner_id","balance","pending"],"variable":[{"key":"partner_id","value":"9f6f566d-01d7-4c69-9201-2da505d573a4","description":"The Partner's ID or external ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8008"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 27 Jul 2025 10:45:56 GMT"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Caddy"},{"key":"X-Powered-By","value":"PHP/8.4.10"},{"key":"Content-Length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"type\": \"currency\",\n \"balance\": \"100.00\"\n }\n ]\n}"},{"id":"4ac98202-0155-4a11-adac-c81d633592c4","name":"No balance available","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nodiref.com/partners/:partner_id/balance/pending","host":["https://api.nodiref.com"],"path":["partners",":partner_id","balance","pending"],"variable":[{"key":"partner_id","value":"9f6f566d-01d7-4c69-9201-2da505d573a4","description":"The Partner's ID or external ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8008"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 27 Jul 2025 10:45:03 GMT"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Caddy"},{"key":"X-Powered-By","value":"PHP/8.4.10"},{"key":"Content-Length","value":"26"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": []\n}"}],"_postman_id":"4d700e41-1378-49d7-a43a-235e95e7fe0f"}],"id":"e9eb3195-5908-47be-972f-307c804e09a5","description":"The balance available for the Partner.
\nFor now, the only balance available is currency, but we are planning on adding more balance types, in order to customize it based off of your business logic.
\n","_postman_id":"e9eb3195-5908-47be-972f-307c804e09a5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"/partners","id":"980095e5-a690-4510-99e4-7b994342fdac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/partners","description":"This endpoint retrieves the partners list based on the provided filters.
\nexternal_id (optional): The external ID of the partner.
id (optional): The ID of the partner.
name (optional): The name of the partner.
project_id (optional): The ID of the project associated with the partner.
project -> The project to which the Partner belongs
status -> The status of the Partner
This endpoint retrieves partner information.
\nproject -> The project to which the Partner belongs
status -> The status of the Partner
The Partner's ID or external ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0097afd2-5494-499e-bb51-9f8a18f63343","name":"Get Partners","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/partners"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 21 May 2025 22:27:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"9ef54e02-2fc1-49f7-8496-b6549b8935c9\",\n \"name\": \"Swift, Kemmer and McCullough\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-35cc-42cd-a4b3-178c08a59581\",\n \"name\": \"Renner-Collins\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-41bc-4ac6-8bca-cf1c0eb7ee5b\",\n \"name\": \"Schulist, Friesen and Hickle\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-47ae-4294-8545-f5916169a2e5\",\n \"name\": \"Quitzon Inc\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-4c91-40c3-ac6b-d4ad4d7af568\",\n \"name\": \"Turner-Nienow\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-6258-4a12-90b2-5be467eb76c0\",\n \"name\": \"Kulas, Miller and Cummerata\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-773f-432f-b1b1-1b36067b551b\",\n \"name\": \"Hessel, Barton and Hartmann\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-7c57-4723-89f4-360734f007fd\",\n \"name\": \"Turner Ltd\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-aab3-44e1-baa1-8ed03f7ac9ee\",\n \"name\": \"Kemmer-Sipes\",\n \"external_id\": null\n },\n {\n \"id\": \"9ef54e02-cd8c-467b-81cb-d1587da099e9\",\n \"name\": \"Klocko Ltd\",\n \"external_id\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"first_page_url\": \"http://localhost:8000/api/partners?page=1\",\n \"from\": 1,\n \"last_page\": 138,\n \"last_page_url\": \"http://localhost:8000/api/partners?page=138\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=137\",\n \"label\": \"137\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=138\",\n \"label\": \"138\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/partners?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http://localhost:8000/api/partners?page=2\",\n \"path\": \"http://localhost:8000/api/partners\",\n \"per_page\": 10,\n \"prev_page_url\": null,\n \"to\": 10,\n \"total\": 1378\n }\n}"}],"_postman_id":"e7562bc3-bd18-4c58-81c0-0fc0f9a2167a"},{"name":"/partners","id":"0e57dff0-1426-4aac-bf73-fbb9e3d67c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": \"EXTERNAL_ID\",\n \"name\": \"PARTNER NAME\",\n \"project_id\": \"UUID_PROJECT_ID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/partners","description":"This endpoint allows you to create a new partner by providing the necessary details.
\n{\n \"external_id\": \"External_ID\", // Required\n \"name\": \"Partner Name\", // Required\n \"project_id\": \"PROJECT_UUID\" // Optional\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["partners"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[{"id":"f14b89c9-8a29-4496-84d6-fb9d7a5dccaf","name":"Create Partner","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": \"test-id\",\n \"name\": \"Test Partner\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/partners"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 21 May 2025 22:45:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"0e57dff0-1426-4aac-bf73-fbb9e3d67c5d"},{"name":"/partners/:id","id":"f580bf49-1044-4447-bf3d-637ae4a9cce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": \"EXTERNAL_ID\",\n \"name\": \"PARTNER NAME\",\n \"project_id\": \"UUID_PROJECT_ID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/partners/:id","description":"This endpoint allows you to update an existing partner by providing the necessary details.
\n{\n \"external_id\": \"External_ID\", // Required\n \"name\": \"Partner Name\", // Required\n \"project_id\": \"PROJECT_UUID\" // Optional\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["partners",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"441625fd-403f-4e2d-9b39-dba935dfc7e5","type":"any","value":"9ef54e02-35cc-42cd-a4b3-178c08a59581","key":"id"}]}},"response":[{"id":"7494e345-d91e-4aa8-8b99-421e4ef496b4","name":"Update Partner","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": \"MyExternalId\",\n \"name\": \"Test Name 2\",\n \"project_id\": \"9ef54dff-c212-44d3-a66d-845ce2bfb77e\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/partners/:id","host":["{{base_url}}"],"path":["partners",":id"],"variable":[{"key":"id","value":"9ef54e02-2fc1-49f7-8496-b6549b8935c9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 21 May 2025 22:45:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"f580bf49-1044-4447-bf3d-637ae4a9cce4"},{"name":"/partners/:id","id":"38f3348d-ad86-4548-b39b-fc1ccabd3317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/partners/:id","description":"This endpoint sends an HTTP DELETE request to the specified partner ID to delete the partner data.
\nThe Partner must not have been used, or else you cannot delete it, as it can have anti-fraud data attached, and referral resources such as Links, Rewards, Referrals, Conversions or other
\nThe response of this request is a JSON schema representing the structure of the response data. The schema will define the properties and their data types that will be returned upon successful deletion of the partner data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["partners",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"daa66f96-12e3-4dcf-97b1-d992b51fc5e1","type":"any","value":"9ef54e02-35cc-42cd-a4b3-178c08a59581","key":"id"}]}},"response":[],"_postman_id":"38f3348d-ad86-4548-b39b-fc1ccabd3317"}],"id":"9b32b0f6-06d6-4d34-ad37-760f20d68b7a","description":"project
status
This endpoint retrieves the projects list based on the provided filters.
\nid (optional): The ID of the project.
name (optional): The name of the project.
company_id (optional): The ID of the company associated with the project.
base_url (optional): The base URL of the project.
status_id (optional): The ID of the status of the project.
automatically_approve_conversions (optional): Filter projects based on whether they automatically approve conversions.
automatically_approve_rewards (optional): Filter projects based on whether they automatically approve rewards.
enable_fraud_detection (optional): Filter projects based on whether fraud detection is enabled.
status -> The status of the Project
partners -> The partners associated with the Project
This endpoint retrieves project information.
\nstatus -> The status of the Project
partners -> The partners associated with the Project
This endpoint allows you to create a new project by providing the necessary details.
\n{\n \"name\": \"Default Project\", // Required\n \"base_url\": \"https://nodiref.com\", // Required\n \"cookie_lifetime\": 365, // Max is 365\n \"status_id\": \"\", // Optional, UUID, Default: Active\n \"automatically_approve_conversions\": false, // Optional, Default: false\n \"automatically_approve_rewards\": false, // Optional, Default: false\n \"enable_fraud_detection\": true // Optional, Default: true\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["projects"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"45031b33-4ce6-4900-b75f-007074da38a6"},{"name":"/projects/:id","id":"4a56d4e1-2274-4552-bec2-380bdbd56aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"company_id\": \"asd\",\n \"external_id\": \"external-id\",\n \"is_internal\": true,\n \"name\": \"Test Name 2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/projects/:id","description":"This endpoint allows you to update an existing project by providing the necessary details.
\n{\n \"name\": \"Default Project\", // Required\n \"base_url\": \"https://nodiref.com\", // Required\n \"cookie_lifetime\": 365, // Max is 365\n \"status_id\": \"\", // Optional, UUID, Default: Active\n \"automatically_approve_conversions\": false, // Optional, Default: false\n \"automatically_approve_rewards\": false, // Optional, Default: false\n \"enable_fraud_detection\": true // Optional, Default: true\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["projects",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"7b411563-2472-4d24-aab5-b40030bfc771","type":"any","value":"9ebf0a3b-6d2b-4016-9d52-7fc97621f428","key":"id"}]}},"response":[],"_postman_id":"4a56d4e1-2274-4552-bec2-380bdbd56aba"},{"name":"/projects/:id","id":"741363c3-f68a-45a3-8dcf-7ef49315f885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/projects/:id","description":"This endpoint sends an HTTP DELETE request to the specified partner ID to delete the partner data.
\nThe Project must not have been used, or else you cannot delete it, as it can have anti-fraud data attached, and referral resources such as Partners, Referrals, Conversions or other
\nThe response of this request is a JSON schema representing the structure of the response data. The schema will define the properties and their data types that will be returned upon successful deletion of the project data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["projects",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"099ffd8c-43b2-4305-9ecb-0c1c05e7910d","type":"any","value":"9eb764e6-c87b-4229-9326-866ca32b6b68","key":"id"}]}},"response":[],"_postman_id":"741363c3-f68a-45a3-8dcf-7ef49315f885"}],"id":"fc87f0f7-b27f-4d23-8500-f8299b4351d3","_postman_id":"fc87f0f7-b27f-4d23-8500-f8299b4351d3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Referral Links","item":[{"name":"/referral-links","id":"a6a7543d-9dd9-4f31-bf7a-ac11cb7a7b47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/referral-links","description":"This endpoint retrieves the referral links list based on the provided filters.
\npartner_id (optional): The ID of the partner associated with the link.
project_id (optional): The ID of the project with the link.
code (optional): The unique code of the referral link.
partner -> The partner associated with the link
project -> The project associated with the link
clicks -> The clicks associated with the link
referrals -> The referrals generated through this link
rewardRuleSets -> The reward rule sets associated with this link
This endpoint retrieves the referral links list based on the provided filters.
\npartner_id (optional): The ID of the partner associated with the link.
project_id (optional): The ID of the project with the link.
code (optional): The unique code of the referral link.
partner -> The partner associated with the link
project -> The project associated with the link
clicks -> The clicks associated with the link
referrals -> The referrals generated through this link
rewardRuleSets -> The reward rule sets associated with this link
This endpoint allows you to create a new referral link by providing the necessary details.
\n{\n \"partner_id\": \"PARTNER_UUID\", // Required\n \"code\": \"UNIQUE_CODE\", // Required\n \"metadata\": {}, // Optional\n \"project_id\": \"PROJECT_UUID\" // Optional\n}\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["referral-links"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0398319c-3f05-48f7-a920-7ee12deef30c"},{"name":"/referral-links/:id","id":"b00d493c-174d-4335-bea8-ead719c5936f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"partner_id\": \"9ebf1841-22c4-4d30-942e-7c7eb942a7a3\",\n \"code\": \"abcdefgghijklmnop\",\n \"target_url\": \"https://nodifyit.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/referral-links/:id","description":"This endpoint allows you to update an existing referral link by providing the necessary details.
\n{\n \"partner_id\": \"PARTNER_UUID\", // Required\n \"code\": \"UNIQUE_CODE\", // Required\n \"metadata\": {}, // Optional\n \"project_id\": \"PROJECT_UUID\" // Optional\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["referral-links",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"e6831d24-7c3d-4035-b15a-284d3f831f93","type":"any","value":"9ebf1864-aca2-40c4-9cc6-0ed9ae961e01","key":"id"}]}},"response":[],"_postman_id":"b00d493c-174d-4335-bea8-ead719c5936f"},{"name":"/referral-links/:id","id":"0808bb2f-cff8-4a52-9423-e64827aa8a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/referral-links/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["referral-links",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"9ba9fd97-4b6e-43b8-8248-fb7621e197a4","type":"any","value":"9ebf1864-aca2-40c4-9cc6-0ed9ae961e01","key":"id"}]}},"response":[],"_postman_id":"0808bb2f-cff8-4a52-9423-e64827aa8a70"}],"id":"1c5bd271-d113-454e-b131-1dc5da9129db","_postman_id":"1c5bd271-d113-454e-b131-1dc5da9129db","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Rewards","item":[{"name":"Rule Sets","item":[{"name":"/rewards/rule-sets","id":"aebb27cc-0268-4ac7-9ae6-57766b42e2ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/rewards/rule-sets","description":"This endpoint retrieves the reward rule sets list based on the provided filters.
\nid (optional): The ID of the reward rule set
name (optional): The name of the reward rule set
status_id (optional): The status ID of the reward rule set
status -> The status of the reward rule set
scopable -> The model this rule set is scoped to (Partner, ReferralLink, etc.)
triggers -> The triggers associated with this rule set
actions -> The actions associated with this rule set
This endpoint retrieves reward rule set information.
\nstatus -> The status of the reward rule set
scopable -> The model this rule set is scoped to (Partner, ReferralLink, etc.)
triggers -> The triggers associated with this rule set
actions -> The actions associated with this rule set
This endpoint allows you to create a new reward rule set by providing the necessary details.
\n{\n \"name\": \"Rule Set Name\", // Required\n \"description\": \"Rule Set Description\", // Optional\n \"starts_at\": \"2024-03-20T00:00:00Z\", // Optional\n \"ends_at\": \"2024-04-20T00:00:00Z\", // Optional\n \"scopable_id\": \"UUID\", // Optional\n \"scopable_type\": \"Model Class\", // Optional\n \"status_id\": \"STATUS_UUID\" // Optional\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","rule-sets"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"60f83469-f3b4-488a-b863-292c53c4b2bc"},{"name":"/rewards/rule-sets/:id","id":"c9974cb8-067e-4772-b0e6-67fb369da626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Iván Update\",\n \"description\": \"Test Iván Update Desc\",\n \"is_active\": false,\n \"starts_at\": \"2025-01-01\",\n \"ends_at\": \"2025-12-31\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/rule-sets/:id","description":"This endpoint allows you to update an existing reward rule set by providing the necessary details.
\n{\n \"name\": \"Rule Set Name\", // Required\n \"description\": \"Rule Set Description\", // Optional\n \"starts_at\": \"2024-03-20T00:00:00Z\", // Optional\n \"ends_at\": \"2024-04-20T00:00:00Z\", // Optional\n \"scopable_id\": \"UUID\", // Optional\n \"scopable_type\": \"Model Class\", // Optional\n \"status_id\": \"STATUS_UUID\" // Optional\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","rule-sets",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"2407fc6f-a993-49e2-ac38-5b4dd42a3d20","type":"any","value":"9ec74145-51b5-492b-97bf-9a51f5b05f2d","key":"id"}]}},"response":[],"_postman_id":"c9974cb8-067e-4772-b0e6-67fb369da626"},{"name":"/rewards/rule-sets/:id","id":"0c7b3900-5fd8-4be6-accf-37b57491c539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/rewards/rule-sets/:id","description":"This endpoint sends an HTTP DELETE request to the specified reward rule set ID to delete the rule set data.
\nThe Reward Rule Set must not have any active rewards or be referenced by any active referrals.
\nThe response of this request is a JSON schema representing the structure of the response data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","rule-sets",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"64e588d0-b109-4045-b1ff-6ca59a91770d","type":"any","value":"9eb93359-5d00-42e9-9449-077e5cffb393","key":"id"}]}},"response":[],"_postman_id":"0c7b3900-5fd8-4be6-accf-37b57491c539"}],"id":"be8e757c-f97b-44fc-8525-234a92516105","description":"The Rule Sets are used to manage the rules that dictate how and when a conversion would be rewarded, each rule set is divided into two main parts:
\nTriggers - These are used to determine what will trigger a reward. Each Trigger can be formed by one or many Trigger Conditions, to better specify the trigger conditions.
\nActions - This is how we will reward the conversion.
\nThis endpoint retrieves the reward triggers list based on the provided filters.
\nid (optional): The ID of the reward trigger
reward_rule_set_id (optional): The ID of the rule set this trigger belongs to
trigger_type (optional): The type of trigger
ruleSet -> The rule set this trigger belongs to
conditions -> The conditions associated with this trigger
This endpoint allows you to create a new reward trigger by providing the necessary details.
\n{\n \"reward_rule_set_id\": \"RULESET_UUID\", // Required\n \"trigger_type\": \"TRIGGER_TYPE\" // Required\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6a4f659-6851-463c-a5f0-2724c0583efa"},{"name":"/rewards/triggers/:id","id":"d74816c5-5161-47a4-86d5-4cf74efd7d81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"reward_rule_set_id\": \"9ebf2161-3a22-4ae7-92e2-ca32fa668b9a\",\n \"trigger_type\": \"subscription\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/triggers/:id","description":"This endpoint allows you to update an existing reward trigger by providing the necessary details.
\n{\n \"reward_rule_set_id\": \"RULESET_UUID\", // Required\n \"trigger_type\": \"TRIGGER_TYPE\" // Required\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"5d14bc03-c7e9-4f7e-ad5e-541de67b827a","type":"any","value":"9ebf2527-ec9d-464f-bb3a-67e74390245e","key":"id"}]}},"response":[],"_postman_id":"d74816c5-5161-47a4-86d5-4cf74efd7d81"},{"name":"/rewards/triggers/:id","id":"32fd70e2-b6cf-42ce-859f-c9794d9242db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/rewards/triggers/:id","description":"This endpoint sends an HTTP DELETE request to the specified reward trigger ID to delete the trigger data.
\nThe response of this request is a JSON schema representing the structure of the response data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"7a742216-ff85-48c8-ab40-873a33460026","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"32fd70e2-b6cf-42ce-859f-c9794d9242db"}],"id":"eee4712f-607b-485a-95d2-4666bf094072","_postman_id":"eee4712f-607b-485a-95d2-4666bf094072","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Trigger Conditions","item":[{"name":"/rewards/triggers/conditions","id":"d4e299be-4516-424a-ac41-c8a59b5a1af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/rewards/triggers/conditions","description":"This endpoint retrieves the reward trigger conditions list based on the provided filters.
\nid (optional): The ID of the reward trigger condition
reward_trigger_id (optional): The ID of the trigger this condition belongs to
trigger -> The trigger this condition belongs toThis endpoint retrieves reward trigger condition information.
\ntrigger -> The trigger this condition belongs toThis endpoint allows you to create a new reward trigger condition by providing the necessary details.
\n{\n \"reward_trigger_id\": \"TRIGGER_UUID\", // Required\n \"field\": \"FIELD_NAME\", // Required\n \"operator\": \"OPERATOR\", // Required\n \"value\": \"CONDITION_VALUE\" // Required\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers","conditions"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c020da5-09ae-432c-89a9-7f07a6c1d81e"},{"name":"/rewards/triggers/conditions/:id","id":"7f84c044-361c-40b1-91b8-d2906eb54367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"reward_trigger_id\": \"9ebf2527-ec9d-464f-bb3a-67e74390245e\",\n \"field\": \"amount\",\n \"operator\": \"<\",\n \"value\": \"500\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/triggers/conditions/:id","description":"This endpoint allows you to update an existing reward trigger condition by providing the necessary details.
\n{\n \"reward_trigger_id\": \"TRIGGER_UUID\", // Required\n \"field\": \"FIELD_NAME\", // Required\n \"operator\": \"OPERATOR\", // Required\n \"value\": \"CONDITION_VALUE\" // Required\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers","conditions",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"55489923-5e4f-47d9-9e2b-6b5b6cd843bb","type":"any","value":"9ebf36da-d793-4f97-b455-8d4a6b8a52dc","key":"id"}]}},"response":[],"_postman_id":"7f84c044-361c-40b1-91b8-d2906eb54367"},{"name":"/rewards/triggers/conditions/:id","id":"4cf7a0e1-77cf-4518-a6ea-0b684d16cfcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/rewards/triggers/conditions/:id","description":"This endpoint sends an HTTP DELETE request to the specified reward trigger condition ID to delete the condition data.
\nThe response of this request is a JSON schema representing the structure of the response data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","triggers","conditions",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"9c8e097a-a08c-4a4f-9e58-c82e42fd2e05","type":"any","value":"9ebf36da-d793-4f97-b455-8d4a6b8a52dc","key":"id"}]}},"response":[],"_postman_id":"4cf7a0e1-77cf-4518-a6ea-0b684d16cfcf"}],"id":"88f351db-6a04-412e-ac7e-e6d7e784d121","_postman_id":"88f351db-6a04-412e-ac7e-e6d7e784d121","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Action","item":[{"name":"/rewards/actions","id":"d3983925-98e5-47c1-9028-dd08db19b65c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/rewards/actions","description":"This endpoint retrieves the reward actions list based on the provided filters.
\nid (optional): The ID of the reward action
reward_rule_set_id (optional): The ID of the rule set this action belongs to
currency (optional): The currency of the reward
reward_type (optional): The type of reward
ruleSet -> The rule set this action belongs toThis endpoint retrieves the reward actions list based on the provided filters.
\nid (optional): The ID of the reward action
reward_rule_set_id (optional): The ID of the rule set this action belongs to
currency (optional): The currency of the reward
reward_type (optional): The type of reward
ruleSet -> The rule set this action belongs toThis endpoint allows you to create a new reward action by providing the necessary details.
\n{\n \"reward_rule_set_id\": \"RULESET_UUID\", // Required\n \"reward_type\": \"REWARD_TYPE\", // Required\n \"reward_amount\": \"AMOUNT\", // Required\n \"max_cap\": \"MAX_CAP\", // Optional\n \"currency\": \"CURRENCY_CODE\" // Optional\n}\n\nThe response for this request is an empty array with a 201 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","actions"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"05c193a7-2872-4b56-be89-80228712c25b"},{"name":"/rewards/actions/:id","id":"2cf05b31-ba95-4fcf-9fde-8a960fc773e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"reward_rule_set_id\": \"9ebf2161-3a22-4ae7-92e2-ca32fa668b9a\",\n \"action_type\": \"something here\",\n \"reward_type\": \"percentage\",\n \"reward_amount\": \"5\",\n \"max_cap\": \"500\",\n \"currency\": \"EUR\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/actions/:id","description":"This endpoint allows you to update an existing reward action by providing the necessary details.
\n{\n \"reward_rule_set_id\": \"RULESET_UUID\", // Required\n \"reward_type\": \"REWARD_TYPE\", // Required\n \"reward_amount\": \"AMOUNT\", // Required\n \"max_cap\": \"MAX_CAP\", // Optional\n \"currency\": \"CURRENCY_CODE\" // Optional\n}\n\nThe response for this request is an empty array with a 200 HTTP Code
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","actions",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"2f94e175-8598-4617-a935-52ca3abc0b56","type":"any","value":"9ebf3b88-8a91-4b07-9658-ea4f4941ccb0","key":"id"}]}},"response":[],"_postman_id":"2cf05b31-ba95-4fcf-9fde-8a960fc773e1"},{"name":"/rewards/actions/:id","id":"51d1bf4d-a48b-44cf-a60c-fddcc34722a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.nodiref.com/rewards/actions/:id","description":"This endpoint sends an HTTP DELETE request to the specified reward action ID to delete the action data.
\nThe response of this request is a JSON schema representing the structure of the response data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","actions",":id"],"host":["https://api.nodiref.com"],"query":[],"variable":[{"id":"82e69822-917d-440e-adf5-48a785915a00","type":"any","value":"9ebf3b88-8a91-4b07-9658-ea4f4941ccb0","key":"id"}]}},"response":[],"_postman_id":"51d1bf4d-a48b-44cf-a60c-fddcc34722a2"}],"id":"f5a9e82e-8a46-427c-83d1-e34958ba9895","_postman_id":"f5a9e82e-8a46-427c-83d1-e34958ba9895","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Trigger Types","item":[{"name":"Preview from JSON","id":"5dbbc456-52ce-4ecd-86ff-6d58001ccea9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"json_payload\": \"{\\\"amount\\\":100.95,\\\"currency\\\":\\\"EUR\\\",\\\"product_id\\\":\\\"123456789\\\",\\\"is_paid\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/trigger-types/preview-from-json","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","trigger-types","preview-from-json"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5dbbc456-52ce-4ecd-86ff-6d58001ccea9"},{"name":"Create from JSON","id":"bffd292c-8c7a-4919-84c5-34c5b65edff9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"json_payload\": \"{\\\"amount\\\":100.95,\\\"currency\\\":\\\"EUR\\\",\\\"product_id\\\":\\\"123456789\\\",\\\"is_paid\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/rewards/trigger-types/create-from-json","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards","trigger-types","create-from-json"],"host":["https://api.nodiref.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bffd292c-8c7a-4919-84c5-34c5b65edff9"}],"id":"e6b8ba42-abf8-4280-ae45-7bddb51392e7","_postman_id":"e6b8ba42-abf8-4280-ae45-7bddb51392e7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Get Rewards","id":"938188ee-af18-4087-84e4-273ae5959a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.nodiref.com/rewards?filter[status_id]=9eeb9f0e-8023-423d-8368-749c44e43b70&include=status","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}},"urlObject":{"path":["rewards"],"host":["https://api.nodiref.com"],"query":[{"key":"filter[status_id]","value":"9eeb9f0e-8023-423d-8368-749c44e43b70"},{"key":"include","value":"status"}],"variable":[]}},"response":[],"_postman_id":"938188ee-af18-4087-84e4-273ae5959a70"}],"id":"fe771d45-e9a7-414e-8f10-2e2468c9c90b","_postman_id":"fe771d45-e9a7-414e-8f10-2e2468c9c90b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}}],"id":"4eddb8db-97c6-4174-9afb-03f61b4aa27c","description":"The partners are the main resource in the referral system. This resource will hold the Referral Links and all the stats within each link.
\nTypically a Partner will have one link, but there are some custom integrations who manage multiple links per partner.
\n","_postman_id":"4eddb8db-97c6-4174-9afb-03f61b4aa27c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"073dc2c1-fe54-4854-8020-bae53a3edb49","id":"073dc2c1-fe54-4854-8020-bae53a3edb49","name":"NodiRef API","type":"collection"}}},{"name":"Public","item":[{"name":"Register Click","id":"123f15c9-729c-4ad0-84d7-0b610a2539aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Company-Id","value":"","description":"The company ID to identify the requests
\n","type":"text"}],"url":"https://api.nodiref.com/v1/:code/hit","description":"Use this endpoint to register a click and get a tracking ID for a user that clicked on a link, this value is recommended to save it in a Cookie, in order to send it over when (if) the user signs up, in order to create the Referral.
\nNote: If you are using our SDKs for the front-end, we automatically manage the persistance of the tracking_id.
{\n \"tracking_id\": \"cf267848-5001-4b7a-9e16-46a285d2f7e8\",\n \"cookie_settings\": {\n \"expires\": 10368000,\n \"path\": \"/\",\n \"secure\": true,\n \"sameSite\": \"Lax\"\n }\n}\n\nThis is the code of the Partner which is shared in the link under the ?ref parameter
The POST /v1/referral endpoint is used to create a new referral with the provided tracking ID.
A Referral is used to simulate a user in your platform in order to better track the conversions, you should create a referral when a user signs up after using a Partner's link/code.
\ntracking_id (string, required): The unique tracking ID for the referral. You can get this Tracking ID from the click event registered in the GET /v1/:code/hit route.
external_id (string, optional): This is the ID of the user in your platform, it is not required, but strongly recommended in order to make the relation easier and better track the users, you can either send us the external_id or save the referral ID in your platform to maintain the relationship.
user_agent (string, optional): The user's user_agent when signing up.
ip_address -> The user's IP Address when signing up
If you are creating the referral from your back-end, it is strongly recommended to send the user's user_agent and ip_address in order to have better results in the Fraud Detection System, if you are sending it from the front-end or using our SDK, we'll automatically get all headers needed from the client.
Upon successful creation, the API returns a status code of 200 and a JSON object with the referral_id field.
Example Response:
\n{\n \"referral_id\": \"example_referral_id\"\n}\n\nThe Company UUID to be able to identify the user with the external ID
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"Partner ID or External ID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nodiref.com/v1/identify","description":"The POST /v1/identify endpoint is used to identify the partner on the current session, this way we can track their metadata, this information is used on the anti-fraud system, it will help us identify if the conversions were made by the Partner himself or not, among with other verifications we do to ensure you get legitimate conversions.
This request must be sent from the client-side (browser or mobile app), and not the server.
\nid (string, required): The ID of the partner in NodiRef or the external_id linked to them (Have to send the X-Company-Id header to use the external_id)The endpoint POST /v1/convert is used to register a new conversion for a referral.
In order to create a new conversion, you will need a referral to link it back to the partner who created it. If your flow does not require users to sign up for the conversion, you might create a new Referral using the POST /v1/referral route and using the ID provided to create the conversion.
referral_id (string): The referral ID for the conversion. You can also use the external_id instead, if you've register it in the Referral creation.
event_type (string): The type of event for the conversion.
payload (object): The payload containing the data to be converted.
If the request is being sent in the back-end, in order to enable the correct Fraud Detection checks, make sure to forward the headers sent from the front-end to correctly register them. The most important headers are:
\nREMOTE_ADDR -> The IP Address of the client, make sure it's the IP sent by the client. If you use a internal proxy, you might have a X-FORWARDED-FOR header with the client's IP forwarded by your proxy or the X-Real-IP forwarded by external proxys.
User-Agent -> This is the User Agent of your client, if you cannot override the User-Agent in the Headers of your request, you can sent a X-User-Agent instead with the client's User Agent.
X-Company-Id -> When making the request using the external_id, you have to also send a X-Company-Id header with your company ID (Found in your Dashboard in the back office). This is only if you are using external_id, if you are using the referral_id instead, this header is not required.These endpoints are used to interact with the API in a public environment, to handle for example the clicks, referral creation and convertions.
\nThe click or hit, are the main source of interaction, as when a user clicks on a link and lands on the configured landing page, we'll send a HIT event to the API that will return a tracking code, which needs to be stored in the cookies of the browser for future reference.
\nThis is a resource that will simulate a potential customer, this can be used to link resources such as users in an app or clients in a e-commerce, it has an external ID that can be sent in order to make the relationship in the app.
\nWhen sending a referral creation, we'll need to send the tracking code returned by the click event, in order to trace the referral. Once created, it will return a referral ID which could be stored somewhere, or not stored at all if you have access to their ID sent as an external_id (I.E the user's ID in your app)
The referral is put in place as a way to persist the referral made, and to enable long rewards if configured (Meaning that the referee will get a reward on every purchase made by the referral - This can be configured in your platform)
\nThe convertion is when a purchase has been made essentially, and you'd want to let the API know that the user with a specific external ID or Referral ID has made a purchase in order to start the computation of the rewards based on the Reward Rule Sets configured in your account.
\nThe normal flow of the events, is the following:
\nThe user clicks on a link and lands into the landing page with a code in the URL
\nExtract the code from the URL and send a HIT to get a tracking_id
Store the tracking_id into the cookies
When the user creates a new account, use the tracking_id to create a referral of that user and store the user ID
When the user makes a purchase, send a request with the details to the conversion endpoint
\nThe conversion will be stored as pending or accepted depending on your configuration
When the conversion is accepted the system will compute the rewards based on your Reward Rule Set configurations.