{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e9646500-1a1e-4311-9dfe-f8c589d5f02a","name":"Alfred Community API Documentation","description":"## API Reference\n\nThe Alfred Community API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.\n\nThis guide explains how to use the reference.\n\n## Before you start\n\nYou communicate to the Alfred Community API through HTTP messages called requests. Especially if you're coming to us new, you might want to familiarize yourself with Four essential components of an API request — headers, endpoints, methods, and parameters — just so we're speaking the same language going forward.\n\n*You can use the API in test mode, which does not affect our live data. The Environment you use to authenticate the request determines the mode of the API. There are two Environments;QA Environment & Production Environment*\n\n### Standard Response object\n\n* * *\n\n#### Success Response:\n\n```\n{\n    \"data\": {*JSON Object*},\n    \"statusCode\": 200\n}\n\n```\n\n#### Error Response:\n\n```\n{\n    \"error\": {\"message\": \"Event not found\"},\n    \"statusCode\": 404\n}\n\n```\n\nAbove response formats are standard formats you can expect on success or failure of an endpoint.\n\n* * *\n\n### Error Codes\n\nAlfred community uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, or type of parameter was wrong, etc.). Codes in the 5xx range indicate an error with Alfred's servers (these are rare). Error response will be JSON-encoded.\n\n### Environments:\n\nThere are two environments available; Sandbox & Production. Documentation includes only sandbox environment and to access the production environment you must use our production url after getting approval of production access.  \n  \nPRODUCTION URL : `https://developers.hom.events`\n\n#### Expected Error Codes\n\n```\n404: Resource not found\n401: Authentication Error\n400: Bad Request Payload/Parameter\n403: Forbidden (Suspicious request)\n405: Method not allowed\n406: Request not acceptable (Bad request Payload)\n500: Server Error (Rare)\n502: Bad Gateway (Rare)\n\n```\n\n* * *\n\n### Authentication Header format\n\nThere are two types of authentication involved in the integration process; Partner Authentication and Partner's User Authentication.\n\n#### Partner Authentication\n\nThis authentication requires partner to authenticate with Alfred Community system and access the resources. After authentication, partner will receive access token, which he needs to provide in Authorization header to make subsequent request, below is the format:\n\n> Authorization: Bearer `accessToken`\n\n#### User Authentication\n\nThis authentication requires partner's user to authenticate with Alfred Community system and make action on behalf of user. We create a non-usable account of user on our side in order to keep the consistency in the flow control. After authentication, partner will receive `userToken`, which he needs to provide in User-Token header to make subsequent requests along with Authorization header:\n\n> Authorization: Bearer `accessToken`  \n> User-Token: `userToken`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11519099","collectionId":"e9646500-1a1e-4311-9dfe-f8c589d5f02a","publishedId":"UVC5DmoU","public":true,"publicUrl":"https://docs.hom.events","privateUrl":"https://go.postman.co/documentation/11519099-e9646500-1a1e-4311-9dfe-f8c589d5f02a","customColor":{"top-bar":"303030","right-sidebar":"303030","highlight":"Eb2E2A"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.11.4","publishDate":"2021-12-02T11:50:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"QA Environment","id":"cc951fbc-f175-48c7-8863-49fc19c30d56","owner":"11519099","values":[{"key":"base_url","value":"https://developer-dev.hom.events","enabled":true},{"key":"auth_url","value":"https://dev-auth.hom.events","enabled":true},{"key":"partnerAccess","value":"","enabled":true},{"key":"sandboxIdentityToken","value":"","enabled":true},{"key":"sandboxSecret","value":"","enabled":true},{"key":"productionIdentityToken","value":"","enabled":true},{"key":"productionSecret","value":"","enabled":true},{"key":"event_id","value":"","enabled":true},{"key":"userAccess","value":"","enabled":true},{"key":"identityToken","value":"","enabled":true},{"key":"secret","value":"","enabled":true},{"key":"developerId","value":"","enabled":true},{"key":"eventId","value":"","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://hom.events/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":"QA Environment","value":"11519099-cc951fbc-f175-48c7-8863-49fc19c30d56"}],"canonicalUrl":"https://docs.hom.events/view/metadata/UVC5DmoU"}