{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"92343662-82f6-4de7-ae42-36bbeabe8f00","name":"Partners API","description":"Welcome to the **John Paul Partner API**, the secure gateway that allows our partners to interact with the John Paul concierge ecosystem.\n\nThis API provides a standardized and secure way to:\n\n- Access and manage member data\n    \n- Handle member subscriptions\n    \n- Create and track concierge requests\n    \n- Integrate with authentication and encryption mechanisms designed for high-security data exchange\n    \n\nAll API endpoints follow a **RESTful architecture** and are intended for **machine-to-machine (M2M)** integrations between your systems and John Paul’s backend services.\n\n### **Key Characteristics**\n\n- **Protocol:** HTTPS only\n    \n- **Format:** JSON\n    \n- **Authentication:** OAuth 2.0 (JWT tokens)\n    \n- **Encryption:** AES/RSA hybrid encryption layer for sensitive data\n    \n- **Rate limiting:** Fair-use policy (no strict limit enforced)\n    \n- **Environments:** GLOBAL / VISA / NAM-PROD\n    \n\n### **Security by Design**\n\nAll communications with the API are encrypted and authenticated.\n\nEndpoints that handle personal or sensitive data require an additional encryption layer.\n\nEach request must include a `Session-Key` header that contains an AES key encrypted using the RSA public key provided by `/v1/crypto/public-key`.\n\nThis ensures that sensitive information is never exchanged in clear text, including in the API responses.\n\n### **Getting Started**\n\n1. Retrieve your partner credentials (`CLIENT_ID`, `CLIENT_SECRET`).\n    \n2. Authenticate your application through the Authorization Server to obtain your access token.\n    \n3. Include your access token and `Session-Key` header in all relevant requests.\n    \n4. Refer to the **Overview** and **Authentication** sections for step-by-step guidance and ready-to-use examples.\n    \n\n### **Notes**\n\nAll endpoints in this workspace include ready-to-run examples and sample responses.\n\nWe strongly encourage testing directly within Postman to accelerate your integration process.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16469949","team":38464,"collectionId":"92343662-82f6-4de7-ae42-36bbeabe8f00","publishedId":"2s946cgEdH","public":true,"publicUrl":"https://doc.api.johnpaultech.com","privateUrl":"https://go.postman.co/documentation/16469949-92343662-82f6-4de7-ae42-36bbeabe8f00","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2023-07-12T09:32:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"JP-STAGING","id":"72ca6162-ac62-40b1-8953-c5f38ef82852","owner":"16469949","values":[{"key":"api-gateway-url","value":"https://api.jp-staging.cluster.johnpaultech.com","enabled":true,"type":"default"},{"key":"client-id","value":"","enabled":true,"type":"default"},{"key":"client-secret","value":"","enabled":true,"type":"default"},{"key":"client-access-token","value":"example-access-token","enabled":true},{"key":"member-uuid","value":"example-member-uuid","enabled":true},{"key":"id_request","value":"{id_request}","enabled":true,"type":"default"},{"key":"session-key","value":"LdIOwXTNlPznXWCpCnbUfcTf43XH8CE8NnIRpHDNuieSK63QLz0ApKVJOyw+z6ey0XpjwkylayiIFFwXIk2aMn9b0atuNDs9GFns8wTiFqVsN03iWomRyzuI5oFHZ+CkMVE5IFL61kbzjhF6+/7hgjY/YPSgLgb6vQulRjH+sOMi4rsNxDMxS5HPj81cklmq+2AWVlBec04HQBi/X96HwhjIb1PGcnQ24zgk4lCgPpSs5zRiWtz9cU5HdpcctOEtdTh72pQoropC7Xf1oFXeC79RmVYPIUxq4fG4bJx5zGOIxn0zWqpHRSiqYWmIIKvSX60wRwR06eaKxr03untOLw==","enabled":true,"type":"default"},{"key":"external_id","value":"{external_id}","enabled":true},{"key":"subscription_id","value":"{subscription_id}","enabled":true},{"key":"family_name","value":"{family_name}","enabled":true},{"key":"contract_id","value":"49403274","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/56758b21358922c658778696da014469301f854929d905d55487528d9a257ace","favicon":"https://res.cloudinary.com/postman/image/upload/v1559901999/team/strctoocyxtbitdw3ncc.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":"JP-STAGING","value":"16469949-72ca6162-ac62-40b1-8953-c5f38ef82852"}],"canonicalUrl":"https://doc.api.johnpaultech.com/view/metadata/2s946cgEdH"}