{"info":{"_postman_id":"d29f4d33-51a7-4959-89fb-5d344fc6ea94","name":"HTN-AFF-SDK","description":"

Hypernet affiliate SDK

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1538221","collectionId":"d29f4d33-51a7-4959-89fb-5d344fc6ea94","publishedId":"UVXqDrvq","public":true,"customColor":{"top-bar":"100E1F","right-sidebar":"100E1F","highlight":"F23D83"},"publishDate":"2024-02-12T13:15:31.000Z"},"item":[{"name":"Lead.search","id":"829a8595-9455-4534-9829-32bd82317990","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your api key, ask your manager","type":"text"}],"url":"https://your.domain/api/external/integration/lead?skip=0&take=250&from=2024-11-01T00:00:00.000Z&to=2024-11-15T23:59:59.999Z","urlObject":{"protocol":"https","path":["api","external","integration","lead"],"host":["your","domain"],"query":[{"key":"skip","value":"0"},{"key":"take","value":"250"},{"key":"from","value":"2024-11-01T00:00:00.000Z"},{"key":"to","value":"2024-11-15T23:59:59.999Z"}],"variable":[]}},"response":[{"id":"c02393ec-b9fb-497a-804f-b113ba3d68bf","name":"Lead.search","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"6aca18d1-10eb-4e2f-8f1a-da0a74e52199"}],"url":{"raw":"{{host}}/api/external/integration/lead?from=2022-08-02T11:15:39.686Z&to=2022-08-02T14:00:38.042Z","host":["{{host}}"],"path":["api","external","integration","lead"],"query":[{"key":"from","value":"2022-08-02T11:15:39.686Z"},{"key":"to","value":"2022-08-02T14:00:38.042Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"x-trace-id","value":"ti-7a671710-1255-11ed-bd77-571e6f3a20cb"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"520"},{"key":"ETag","value":"W/\"208-To4fa5u2cexZBH6GXk0mMHyXCGQ\""},{"key":"Date","value":"Tue, 02 Aug 2022 11:23:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 9,\n \"rows\": [\n {\n \"id\": \"21fd215f-641a-4e94-bb6a-cdc847a14264\",\n \"registration\": {\n \"rawStatus\": \"New\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"testlead03@gmail.com\",\n \"lastName\": \"HISTORY\",\n \"password\": \"TestSpeed123\",\n \"firstName\": \"TEST\",\n \"phoneCode\": \"1\",\n \"phoneNoCode\": \"2263553568\"\n },\n \"ip\": \"199.119.233.155\",\n \"geo\": \"CA\",\n \"utmSource\": null,\n \"utmMedium\": null,\n \"utmCampaign\": null,\n \"utmId\": null,\n \"subId\": \"sub-HcuAWWO\",\n \"subId_a\": null,\n \"subId_b\": null,\n \"subId_c\": null,\n \"subId_d\": null,\n \"subId_e\": null,\n \"subId_f\": null,\n \"isDeposited\": false,\n \"createdAt\": \"2023-12-11T02:59:49.995Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"b82dc836-8457-47a9-aed8-a6f491bb68ac\",\n \"registration\": {\n \"rawStatus\": \"New\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test-count-07-12-03@gmail.com\",\n \"lastName\": \"HISTORY\",\n \"password\": \"TestSpeed123\",\n \"firstName\": \"TEST\",\n \"phoneCode\": \"1\",\n \"phoneNoCode\": \"2263553568\"\n },\n \"ip\": \"199.119.233.147\",\n \"geo\": \"CA\",\n \"utmSource\": null,\n \"utmMedium\": null,\n \"utmCampaign\": null,\n \"utmId\": null,\n \"subId\": \"ilAJUw6b\",\n \"subId_a\": null,\n \"subId_b\": null,\n \"subId_c\": null,\n \"subId_d\": null,\n \"subId_e\": null,\n \"subId_f\": null,\n \"isDeposited\": false,\n \"createdAt\": \"2023-12-11T00:15:33.221Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"26adef13-d9c2-4619-8265-346f53a37d4c\",\n \"registration\": {\n \"rawStatus\": \"Test\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"testlead17272772es@gmail.com\",\n \"lastName\": \"Test\",\n \"password\": \"aA1234567\",\n \"firstName\": \"Test\"\n },\n \"ip\": \"84.78.242.147\",\n \"geo\": \"ES\",\n \"utmSource\": null,\n \"utmMedium\": null,\n \"utmCampaign\": null,\n \"utmId\": null,\n \"subId\": \"ithhNTM8d\",\n \"subId_a\": null,\n \"subId_b\": null,\n \"subId_c\": null,\n \"subId_d\": null,\n \"subId_e\": null,\n \"subId_f\": null,\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-19T10:19:10.985Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"7ee278a6-18d5-4fc3-a3d5-41d995954878\",\n \"registration\": {\n \"rawStatus\": \"NEW\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test343440@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.165\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksS34sd23сf\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-19T00:28:55.357Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"b59e8000-c80b-4644-b492-db163d0d9037\",\n \"registration\": {\n \"rawStatus\": \"NEW\",\n \"status\": \"deposited\"\n },\n \"profile\": {\n \"email\": \"test343439@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.163\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksS34sd23с\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": true,\n \"createdAt\": \"2023-07-19T00:16:26.115Z\",\n \"depositedAt\": \"2023-07-19T00:20:17.928Z\"\n },\n {\n \"id\": \"829429c2-fe63-466b-89ea-7650b7800be3\",\n \"registration\": {\n \"rawStatus\": \"CALLBACK\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test343438@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.163\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksS34sd23\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-18T23:51:13.390Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"ba540238-2319-4652-91ab-6555c0841c22\",\n \"registration\": {\n \"rawStatus\": \"Not interest\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test343437@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.163\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksLKDS34sd23\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-18T23:39:32.563Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"9763a079-fbac-497c-bd51-32e6b90eabda\",\n \"registration\": {\n \"rawStatus\": \"NEW\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test343436@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.168\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksLKDS34sd2\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-18T23:39:01.680Z\",\n \"depositedAt\": null\n },\n {\n \"id\": \"ac44007d-77f4-455c-b08c-1a26f35da6a8\",\n \"registration\": {\n \"rawStatus\": \"NO_ANSWER\",\n \"status\": \"sent\"\n },\n \"profile\": {\n \"email\": \"test343434@gmail.com\",\n \"lastName\": \"test\",\n \"password\": \"Aa123456\",\n \"firstName\": \"test\"\n },\n \"ip\": \"174.1.116.168\",\n \"geo\": \"CA\",\n \"utmSource\": \"FB\",\n \"utmMedium\": \"CPL\",\n \"utmCampaign\": \"somename\",\n \"utmId\": \"304304903940\",\n \"subId\": \"sdksLKDS34sd\",\n \"subId_a\": \"null\",\n \"subId_b\": \"null\",\n \"subId_c\": \"null\",\n \"subId_d\": \"null\",\n \"subId_e\": \"null\",\n \"subId_f\": \"null\",\n \"isDeposited\": false,\n \"createdAt\": \"2023-07-18T23:35:34.918Z\",\n \"depositedAt\": null\n }\n ]\n}"}],"_postman_id":"829a8595-9455-4534-9829-32bd82317990"},{"name":"Lead.create","id":"903a5d2b-95e0-4774-bc4a-5e68ba6a8e33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your api key, ask your manager","type":"text"}],"body":{"mode":"raw","raw":"{\n // REQUIRED\n \"affc\": \"AFF-tqAsXgAqdi\", // your affiliate id, ask your manager\n \"bxc\": \"BX-TXOB9fhHYxMPI\", // your hub id, ask your manager\n \"vtc\": \"VT-HARJNHZEID2EN\", // vertical id, ask your manager\n \"profile\": { // lead profile in accordance with vertical (all fields are required)\n \"firstName\": \"TEST\",\n \"lastName\": \"TEST\",\n \"email\": \"test@test.com\", // must be a valid email\n \"password\": \"kas3dkDasasd\",\n \"phone\": \"79191452417\" // without +\n },\n \"ip\": \"71.19.252.146\", // lead ip address, must be valid (IPv4 or IPv6)\n \"funnel\": \"tesler\", // name of your funnel\n \"landingURL\": \"https://tesler.com/\", // url address of your funnel\n \"geo\": \"CA\", // country code of lead geo (upper-case)\n \"lang\": \"en\", // language code of lead (lower-case)\n \"landingLang\": \"en\", // language of landing (lower-case)\n // OPTIONAL\n \"userAgent\": null, // OPTIONAL - lead original User-Agent\n \"comment\": null, // OPTIONAL - some specific data about lead, quize etc.\n \"utmSource\": null, // OPTIONAL - source of traffic (e.g. FB or Google)\n \"utmMedium\": null, // OPTIONAL - offer type (e.g. CPA or CPL)\n \"utmCampaign\": null, // OPTIONAL - offer campaing name (e.g. hypernet)\n \"utmId\": null, // OPTIONAL - source pixel id (e.g. ID of FB pixel)\n \"subId\": \"skdaskdKDMSKDsdd\", // OPTIONAL - click id of lead to sync back\n \"subId_a\": null, // OPTIONAL - click additional info\n \"subId_b\": null, // OPTIONAL - click additional info\n \"subId_c\": null, // OPTIONAL - click additional info\n \"subId_d\": null, // OPTIONAL - click additional info\n \"subId_e\": null, // OPTIONAL - click additional info\n \"subId_f\": null // OPTIONAL - click additional info\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain/api/external/integration/lead","urlObject":{"protocol":"https","path":["api","external","integration","lead"],"host":["your","domain"],"query":[],"variable":[]}},"response":[{"id":"a6fe0c18-0c46-447a-a984-bcdedfe0487a","name":"Lead.create [success]","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"6aca18d1-10eb-4e2f-8f1a-da0a74e52199","type":"text"}],"body":{"mode":"raw","raw":"{\n \"affc\": \"AFF-tqAsXgAqdi\",\n \"bxc\": \"BX-TXOB9fhHYxMPI\",\n \"vtc\": \"VT-VP5G3HQL7LAKM\",\n \"profile\": {\n \"firstName\": \"test\",\n \"lastName\": \"test\",\n \"email\": \"test+304893904@test.com\",\n \"password\": \"kas3dkDasasd\",\n \"phone\": \"79191452418\"\n },\n \"ip\": \"71.19.252.146\",\n \"funnel\": \"test\",\n \"landingURL\": \"https://test.com/asdasd\",\n \"geo\": \"CA\",\n \"lang\": \"EN\",\n \"landingLang\": \"EN\",\n \"subId\": \"ksdmKKsd3\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/external/integration/lead"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"x-trace-id","value":"ti-8496e320-1253-11ed-b6ef-854e2d5b3ba2"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"99"},{"key":"ETag","value":"W/\"63-GOKrAStSuJkkbutignzb/Atsq3Q\""},{"key":"Date","value":"Tue, 02 Aug 2022 11:09:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"redirectUrl\": \"https://google.com\",\n \"leadId\": \"aa99ee7b-c52b-43d0-98ba-601e5d864681\"\n}"},{"id":"eaebd4ab-0f92-4b58-867a-9b5a9e095f9d","name":"Lead.create [unexpected error]","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"6aca18d1-10eb-4e2f-8f1a-da0a74e52199","type":"text"}],"body":{"mode":"raw","raw":"{\n \"affc\": \"AFF-tqAsXgAqdi\",\n \"bxc\": \"BX-TXOB9fhHYxMPI\",\n \"vtc\": \"VT-VP5G3HQL7LAKM\",\n \"profile\": {\n \"firstName\": \"test\",\n \"lastName\": \"test\",\n \"email\": \"test+304893904@test.com\",\n \"password\": \"kas3dkDasasd\",\n \"phone\": \"79191452418\"\n },\n \"ip\": \"71.19.252.146\",\n \"funnel\": \"test\",\n \"landingURL\": \"https://test.com/asdasd\",\n \"geo\": \"CA\",\n \"lang\": \"EN\",\n \"landingLang\": \"EN\",\n \"subId\": \"ksdmKKsd3\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/external/integration/lead"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"x-trace-id","value":"ti-0e432e30-1254-11ed-b20c-5543da60b24b"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"140"},{"key":"ETag","value":"W/\"8c-G5siXfG7I6VUdI8pMkeAaw+pXrE\""},{"key":"Date","value":"Tue, 02 Aug 2022 11:12:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"redirectUrl\": null,\n \"leadId\": \"8c7408cc-ed52-4c6d-9ec2-d0f970def897\",\n \"error\": \"Couldn't process, please contact your manager\"\n}"},{"id":"50e59ff3-331d-4082-b611-22d5f41c7272","name":"Lead.create [hub closed]","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"6aca18d1-10eb-4e2f-8f1a-da0a74e52199","type":"text"}],"body":{"mode":"raw","raw":"{\n \"affc\": \"AFF-tqAsXgAqdi\",\n \"bxc\": \"BX-TXOB9fhHYxMPI\",\n \"vtc\": \"VT-VP5G3HQL7LAKM\",\n \"profile\": {\n \"firstName\": \"test\",\n \"lastName\": \"test\",\n \"email\": \"test+304893904@test.com\",\n \"password\": \"kas3dkDasasd\",\n \"phone\": \"79191452418\"\n },\n \"ip\": \"71.19.252.146\",\n \"funnel\": \"test\",\n \"landingURL\": \"https://test.com/asdasd\",\n \"geo\": \"CA\",\n \"lang\": \"EN\",\n \"landingLang\": \"EN\",\n \"subId\": \"ksdmKKsd3\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/external/integration/lead"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"x-trace-id","value":"ti-a95b01e0-1254-11ed-bccb-690f65b3a79a"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"126"},{"key":"ETag","value":"W/\"7e-Hhz3RdaGqKJECYGK582eQsSmMJI\""},{"key":"Date","value":"Tue, 02 Aug 2022 11:17:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"redirectUrl\": null,\n \"leadId\": \"85240843-fb88-4473-9f12-861f4eebcfdb\",\n \"error\": \"Hub is closed: BX-TXOB9fhHYxMPI\"\n}"},{"id":"eecf492a-8f02-444b-bcfa-293d0e180bf1","name":"Lead.create [brand is not connected OR full cap]","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"a89e9112-76e6-4d5a-9322-0abf92e83ea5","type":"text"}],"body":{"mode":"raw","raw":"{\n \"affc\": \"AFF-UBBA2QJNZ1\",\n \"bxc\": \"BX-TXOB9fhHYxMPI\",\n \"vtc\": \"VT-VP5G3HQL7LAKM\",\n \"profile\": {\n \"firstName\": \"test\",\n \"lastName\": \"test\",\n \"email\": \"test+304893904@test.com\",\n \"password\": \"kas3dkDasasd\",\n \"phone\": \"79191452418\"\n },\n \"ip\": \"71.19.252.146\",\n \"funnel\": \"test\",\n \"landingURL\": \"https://test.com/asdasd\",\n \"geo\": \"CA\",\n \"lang\": \"EN\",\n \"landingLang\": \"EN\",\n \"subId\": \"ksdmKKsd3\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/external/integration/lead"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"x-trace-id","value":"ti-0eddb850-1287-11ed-b186-a3a028110a01"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"169"},{"key":"ETag","value":"W/\"a9-mWTY/JxyEw52oFueje59nrIFw3I\""},{"key":"Date","value":"Tue, 02 Aug 2022 17:18:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"redirectUrl\": null,\n \"leadId\": \"9b29cd65-10dd-4f0a-ada7-ec765aa5da8f\",\n \"error\": \"Brand is not connected to the hub: BX-TXOB9fhHYxMPI OR cap is already full\"\n}"}],"_postman_id":"903a5d2b-95e0-4774-bc4a-5e68ba6a8e33"}]}