{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"19348a55-a791-4a1e-ae55-229bdcbdcaca","name":"Rainmaker API","description":"## Rainmaker\nAgnitio helps life science companies generate effective relationships with payers, medical professionals, and their patients.\n\nRainmaker is multichannel software for pharma and medical technology companies. It offers a suite of channels that can be applied independently or in any combination. This multichannel communications suite enables field force to better engage with and deliver more value to clients via multiple touch points.\n\nRainmaker empowers pharma and med-tech teams to deliver high-value personalized interactions, powered by flexible, data-driven tools\n\n* Empowers impactful customer engagements\n* Increases cost-effectiveness\n* Provides actionable market insights\n\nRainmaker is SaaS (Software as a Service) solution that enables you to develop, manage and broadcast content via different channels.\n\nRainmaker platform offers to the users following features:\n* Multichannel CLM\n* E-detailing solution\n* Remote engagements\n* Approved email solution\n* ShareDoc\n* Content management\n* User management\n* Contact and Account management\n* Analytics and reporting\n* Integrations\n\n\n# Rainmaker API\nRainmaker API provides our clients an easy integration to the Rainmaker platform. This software-to-software interface allows your CRM and applications to exchange data with Rainmaker, and it can be used to automate many different processes.\n\n# Getting Started\nIn order to user Rainmaker API you’ll need API Developer account created.\n\nPlease contact Agnitio Professional services or Support for additional information how to get access to the Rainmaker API.\n\n## Base URL\nAll calls to the API need to start with the base URL:\n\n```https://rm-api.agnitio.com/rainmaker/api/v1```\n\n## Authentication\nThe Rainmaker API utilizes OAuth for authentication. Once you've been given an api access token, you must provide this token in each request via the Authorization header as a \"Bearer\" value.\n\nAll requests must include your provided API key in Authorization header:  ```Authorization: Bearer {{api-key}}```\n\n\n# Content Negotiation\n\nAll requests **must** include the header:  ```Accept: application/vnd.api+json```\n\n\n# Available API Endpoints\n\nAt the moment we provide an RESTful API following the JSON API standard (https://jsonapi.org), with functionalities listed in the table below. Full list of endpoints for specific functionalities is available in “API reference” part of this document.\n\n| API      | Description                                                   |\n|----------|---------------------------------------------------------------|\n| JSON API | API provides following endpoints for the following resources: |\n|          | \\* Users                                                      |\n|          | \\* Accounts                                                   |\n|          | \\* Contacts                                                   |\n|          | \\* Content                                                    |\n|          | \\* Categories                                                 |\n|          | \\* Tags                                                       |\n|          | \\* Meetings                                                   |\n|          | \\* MIO                                                        |\n\n\n# Rate Limits\nThe standard API rate limits apply to all endpoints we provide, and limit is 60 requests per minute.\nExceeding defined rate limit will result in API responding with response message: ```429: Too Many Attempts```. \n\n# Response Codes\nRainmaker API responds with HTTP status codes and JSON-based error codes and messages.\n\n## HTTP Status Codes\nThe following table gives an overview of HTTP status codes that are returned.\n\n| HTTP Status Code | Text              | Description                              |\n|------------------|-------------------|------------------------------------------|\n| 200              | OK                | Success\\.                                |\n| 201              | Created           | Object created\\.                         |\n| 204              | No Content        | No content returned\\.                    |\n| 401              | Unauthorized      | Token is missing or invalid\\.            |\n| 403              | Forbidden         | Resource or Request not supported        |\n| 404              | Not Found         | Object not found\\.                       |\n| 406              | Not Acceptable    | Request not acceptable                   |\n| 409              | Conflict          | Application or resource state conflict\\. |\n| 422              | Validation Error  | Validation error occurred\\.              |\n| 429              | Too Many Requests | Rate limit exceeded\\.                    |\n\n\n## Error Messages\n\nThe following example illustrates how an error messages will looks like for HTTP status code ```401 - Unauthorized```.\n\n```\n401 - Unauthorized\n{\n    \"errors\": [\n    {\n        \"status\": “401”,\n        \"title\": \"Unauthorized\",\n        \"detail\": \" Unauthenticated.\"\n    }\n}\n```\n\nRequests sending JSON data **must** include the header:  ```Content-Type: application/vnd.api+json```\n\n\n# Filters\n\nFilters can be applied to supported endpoints to limit the results that are returned. Filters are applied using the `\"filter\"` query parameter. You can find the filter fields that are supported in the **Filter Attributes** section of each endpoint.\n\n**Examples:** \n\nGet a list of active users:\n\n`filter[active][eq]` : `true`\n\n\nFind user by exact username:\n\n`filter[username][eq]` : `johndoe`\n\n\nFind users with username like:\n\n`filter[username][like]` : `johndoe`\n\n\nFind users created after a certain date:\n\n`filter[creaeted_at][gt]` : `2020-01-01`\n\n\n\n**Filter Qualifiers**\n\n  - Equals: [eq]\n\n  - In: [in]\n\n  - Like: [like]\n\n  - Greater than: [gt]\n\n  - Greater than or equal: [gte]\n\n  - Less than: [lt]\n\n  - Less than or equal: [lte]\n\n\n  \n# Compound Documents ##\n\n[JSONAPI - Compound Documents](https://jsonapi.org/format/#document-compound-documents)\n\nTo reduce the number of HTTP requests, responses on supported endpoints may be requested to \"include\" related resources along with the requested primary resources. Included resources are requested by using the `\"include\"` query parameter. You can find the supported includes in the **Available Includes** section of each endpoint.\n\n  \n**Examples:**\n\n  - In the `GET /tags` endpoint, to include the assoicated Category:\n    \n    `include`: category\n\n  - In the `GET /meetings` endppoint, to include the contacts, accounts, and tags:\n    \n    `include`: contacts,accounts,tags","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4219622","collectionId":"19348a55-a791-4a1e-ae55-229bdcbdcaca","publishedId":"SzmYAMbM","public":true,"publicUrl":"https://docs.agnitio.com","privateUrl":"https://go.postman.co/documentation/4219622-19348a55-a791-4a1e-ae55-229bdcbdcaca","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2020-05-26T08:38:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"RM-API: Prod","id":"931fb465-33ce-4f57-a659-920a9cb912c5","owner":"4219622","values":[{"key":"api-url","value":"https://rm-api.agnitio.com/api","enabled":true},{"key":"mobilizer-token","value":"","enabled":true},{"key":"auth-token","value":"2a510dc5b2ac36baff58a3af09f8af8a","enabled":true},{"key":"username","value":"","enabled":true},{"key":"password","value":"","enabled":true},{"key":"org","value":"","enabled":true},{"key":"reset-token","value":"","enabled":true},{"key":"rainmaker-url","value":"https://rm-api.agnitio.com/rainmaker/api/v1","enabled":true},{"key":"bearer-token","value":"","enabled":true},{"key":"remote-token","value":"","enabled":true},{"key":"remote-base-url","value":"https://live.agnitio.com","enabled":true},{"key":"callId","value":"","enabled":true},{"key":"engager-token","value":"2a510dc5b2ac36baff58a3af09f8af8a","enabled":true,"type":"default"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://agnitio.com/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":"RM-API: Prod","value":"4219622-931fb465-33ce-4f57-a659-920a9cb912c5"}],"canonicalUrl":"https://docs.agnitio.com/view/metadata/SzmYAMbM"}