{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"43783741-4655-48e5-a430-88af4f025b45","name":"Navigate dev","description":"API for the Navigate 1.0 App.\nNavigate origin api \n\n## Author\n[lzk@2dm](mailto:lzk@2dm.net.au)\n[kim@2dm](mailto:kim@2dm.net.au)\n## Version\nv1.0\n\n**Copyright © 2020 2dm Digital**\n\n---\n\n# Changelog\n### 2020-08-01(v20200801)\n    -- 通用接口\n    -- influencers\n    -- address \n    -- campaigns\n    -- influencers\n    -- Jobs\n\n### 2020-07-16(v20200716)\n-- clean old api, beautiful api\n-- using nest to do the old project\n\n### 2020-5-22(v20200522)\n-- clean old api,beautiful api\n-- add users query field- totalNotifaction ,campaigns query field total paid\n\n\n### 2020-5-19(v20200519)\n-- 添加创建私密活动自端和 推荐活动列表字段\n\n### 2020-4-10(v20200410)\n-- 修改 活动创建接口\n\n### 2019-12-10(v20191210)\n-- 添加删除草稿接口\n\n### 2019-12-08(v20191208)\n-- 添加收藏接口\n\n### 2019-12-07(v20191207)\n-- 提交 通知 相关接口\n\n### 2019-12-06(v20191206)\n-- 提交 campaigns 相关接口\n\n### 2019-08-15(v20190606)\n-- Matchmaking\n\n### 2019-08-05(v20190606)\n-- Favorites, missions\n\n### 2019-07-20(v20190606)\n-- Jobs\n\n### 2019-07-19(v20190606)\n-- Link and claim social account\n\n### 2019-07-01(v20190606)\n-- transactions endpoint\n\n-- payments endpoint\n\n### 2019-06-014(v20190606)\n-- Linked ENV_VAR to dev api endpoint\n\n-- Added endpoint for authentication-related actions\n\n\n### 2019-06-06(v20190606)\nStarted the basic shell of the API doc\n\n---\n\n# Navigate Web App 各环境前端urls\nFE urls used for testing.\n\n## 1. User-facing:\n\n### China 中国\n\n| **Name**  |**URL**\n| :--- |:--- \n| **Brand** |  [http://app.dev.nvgt.vip](http://app.dev.nvgt.vip)\n| **KOL** |  [http://kol.dev.nvgt.vip](http://kol.dev.nvgt.vip)\n\n\n### Global 全球\n\n| **Name**  |**URL**\n| :--- |:--- \n| **Brand** | [https://navigate-app.dev.2dm.digital](https://navigate-app.dev.2dm.digital)\n| **KOL** | [https://navigate-kol.dev.2dm.digital](https://navigate-kol.dev.2dm.digital)\n\n\n### Admin 管理后台\n\nhttp://navigate-admin.dev.2dm.digital\n\n---\n\n# 全局语法说明\n\nFor most GET calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual GET calls.  \n\n大部分的接口均支持传入字段来筛选返回的信息\n\n\n## 1. 分页 Pagination\n\n`$limit=10&$skip=0`\n\n\n\n`$skip` 为跳过的数据条数，不是页码, 比如，在默认分页数（20）的情况下，$skip=20相当于翻到第二页( skip =（页数-1）*limit)  \n\n`$limit` 为分页的条数，全局默认分页为每页20条，最高为200条, 当需要快速统计条目数时，可以是传入`$limit=0`,这样会直接跳过数据拉取，直接count后返回`total`\n\n```json\n{\n  \"total\": \"<total number of records>\",\n  \"limit\": \"<max number of items per page>\",\n  \"skip\": \"<number of skipped items (offset)>\",\n  \"data\": [/* data */]\n}\n```\n\n\n## 2. 查询和筛选 Query parameters\n\n\n### a. 排序 Sort\n\n`$sort` will sort based on the object you provide. It can contain a list of properties by which to sort mapped to the order (1 ascending, -1 descending).\n\n\nFind the 10 newest influencers\n\n```http\nGET /influencers?$limit=10&$sort[createdAt]=-1\n```\n\n\n### b. 对比 Equality\n\n`$lt` < 小于\n\n\n`$lte` <= 小于等于\n\n\n`$gt` > 大于\n\n\n`$gte` >= 大于等于\n\n```\nGET /transactions?createdAt[$gte]=TIMESTAMP\n```\n\n### c. 选择\n\n`$in` 包含\n`$nin` 不包含\n\n```\nGET /camapgins?status[$in]=pending&status[$in]=inProgress\n```\n\n\n# HTTP Request Headers\n\n\nAll requests to Navigate API (except login and signup action) must pass an authorization token in the header\n\n所有向Navigate API发起的请求（登陆和创建新用户请求除外）都需要在Header中传入token\n\nNavigate uses  `jwt`\n\nNavigate使用  `jwt`\n\n\n# Error Handling 错误处理\n\n\n| Code     | Type   | Class | Description |\n|----------|--------|----------|-------------|\n| 400 | Bad Request | `bad-request`      |     |\n| 401 | Not Authenticated | `not-authenticated`      |     |\n| 402 | Payment Error | `payment-error`      |     |\n| 403 | Forbidden | `forbidden`      |     |\n| 404 | Not Found | `not-found`      |     |\n| 405 | Method Not Allowed | `method-not-allowed`      |     |\n| 406 | Not Acceptable | `not-acceptable`      |     |\n| 408 | Timeout | `timeout`      |     |\n| 500 | GeneralError | `general-error`      |     |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"8174443","team":78020,"collectionId":"43783741-4655-48e5-a430-88af4f025b45","publishedId":"T1DiHgKM","public":true,"publicUrl":"https://docs.2dm.digital","privateUrl":"https://go.postman.co/documentation/8174443-43783741-4655-48e5-a430-88af4f025b45","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-07-17T08:24:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"aliyun:3000","id":"e845f765-f3ec-4398-b7f7-8fd0a0746990","owner":"8174443","values":[{"key":"server","value":"http://120.76.101.229:3000","enabled":true},{"key":"token","value":null,"enabled":true},{"key":"userEmail","value":"variable_value","enabled":true},{"key":"userPwd","value":"variable_value","enabled":true},{"key":"userType","value":"brand","enabled":true},{"key":"nav-admin","value":"http://localhost:4040","enabled":true},{"key":"nav-server","value":"http://120.76.11.229:7001","enabled":true},{"key":"userCreatPhone","value":"+8618468054800","enabled":true},{"key":"verficode","value":299555,"enabled":true},{"key":"createCampaignId","value":null,"enabled":true},{"key":"admin-server","value":"localhost:192.168.1.66:4040","enabled":true},{"key":"password","value":"2dm2dm2DM","enabled":true},{"key":"username","value":"1187482038@qq.com","enabled":true},{"key":"phone","value":"+8615010902120","enabled":true},{"key":"idCampaign","value":"5f3b3a0df3757003dad39708","enabled":true},{"key":"verificationCode","value":"624345","enabled":true},{"key":"userCreatePhone","value":"variable_value","enabled":true},{"key":"brandName","value":"test","enabled":true},{"key":"brandType","value":"agency","enabled":true},{"key":"country","value":"中国","enabled":true},{"key":"industries","value":"[\"Baby\",\"Beauty\"]","enabled":true},{"key":"name","value":"test002","enabled":true},{"key":"email","value":"15010902120@163.com","enabled":true},{"key":"emailtoken","value":"372832","enabled":true},{"key":"oldPassword","value":"2dm2dm2DM","enabled":true},{"key":"idAddress","value":"5f1a4b51c9eb67e28f554301","enabled":true},{"key":"userTypes","value":"brand","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/07f41bb346ef0771f1cba2eef5b4cb9e10c53cc1664e55eb2ac8ef8934fb34a5","favicon":"https://2dm.digital/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"aliyun:3000","value":"8174443-e845f765-f3ec-4398-b7f7-8fd0a0746990"}],"canonicalUrl":"https://docs.2dm.digital/view/metadata/T1DiHgKM"}