aMember PRO REST API v2 server uses [ OAuth 2.0 ][ https://oauth.net/2 ] protocol to authorize requests. \nAuthorisation server supports these grant types: \npassword, client_credentials, authorization_code, refresh_token
\nDownload oauth module from your [ amember.com account ][ http://www.amember.com/amember/member ]
\nInstall and enable module in your aMember CP -> Setup -> Plugins
\nThe public/private key pair is required to sign and verify JWT transmitted. \nTo generate the private key run this command on the terminal:
\nopenssl genrsa -out private.key 2048\nthen extract the public key from the private key:
\nopenssl rsa -in private.key -pubout -out public.key\n \nUpload both files to any folder outside of Web Root, set 0600 permissions for both files. \nThen specify paths in the configuration form.
\nCreate oauth client at aMember CP -> Oauth 2 Server -> Clients\nWhen you create a client you should select permissions and grant types allowed for this client. \nYou should enable only permissions that are necessary for your application, DO NOT ALLOW ALL PERMISSIONS
\nWhen device registration is enabled, amember adds new grant type to server: amember_device\nThat grant type allow to exchange client_id and amember_device_id to access token. Device must be registered first. \nAll further API requests require AMEMBER-DEVICE-ID header to be set. \nWithout that header with correct device_id 403 error will be returned.
\nYou should pass accept header with each request.
\nAccept: application/json\nOauth Client ID (create it in aMember CP -> Oauth Clients )
\n","type":"text"},{"key":"client_secret","value":"CLIENT_SECRET","description":"Oauth Client Secret (autogenerated value available once you create client)
\n","type":"text"},{"key":"grant_type","value":"password","description":"Grant Type is password for this request
\n","type":"text"},{"key":"scope","value":"me.fullprofile me.subscriptions","description":"List of requested scopes. Scopes are unique for each endpoint. Do not request more scopes then necessary.
\n","type":"text"},{"key":"username","value":"USERNAME","description":"User's login. Access token will gant an access to user's account. All future reuests will be process on behalf of this user.
\n","type":"text"},{"key":"password","value":"PASSWORD","description":"User's password
\n","type":"text"}]},"url":"http://example.com/amember/oauth/token","description":"Exchange client login credentials to access token.
\n","urlObject":{"protocol":"http","path":["amember","oauth","token"],"host":["example","com"],"query":[],"variable":[]}},"response":[{"id":"db95bd2c-b87e-4445-bdf6-036461365df9","name":"Get Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"CLIENT_ID","description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )","type":"text"},{"key":"client_secret","value":"CLIENT_SECRET","description":"Oauth Client Secret (autogenerated value available once you create client)","type":"text"},{"key":"grant_type","value":"password","description":"Grant Type is *password* for this request","type":"text"},{"key":"scope","value":"me.fullprofile me.subscriptions","description":"List of requested scopes. Scopes are unique for each endpoint. Do not request more scopes then necessary.\n","type":"text"},{"key":"username","value":"USERNAME","description":"User's login. Access token will gant an access to user's account. All future reuests will be process on behalf of this user. ","type":"text"},{"key":"password","value":"PASSWORD","description":"User's password","type":"text"}]},"url":"https://example.com/amember/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Nov 2018 20:30:23 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1959"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 12959999,\n \"access_token\": \"JWT token\",\n \"refresh_token\": \"JWT token\"\n}"}],"_postman_id":"2484b64e-6428-48fd-aa6b-cd202ca3f994"}],"id":"a7f9df06-66f2-4754-8d9e-8357dd168e21","description":"Used to authorize thrid-party clients both in web-browser or native applicatons.\nWith password grant type, client first need to get login credentials from user and then exchange them to authorizaton token.
\n","event":[{"listen":"prerequest","script":{"id":"74ee3590-deda-4566-ac97-e233bf25fb5b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4911c14a-122f-4995-be60-52de4dc4065c","type":"text/javascript","exec":[""]}}],"_postman_id":"a7f9df06-66f2-4754-8d9e-8357dd168e21"},{"name":"Grant Type: client_credentials","item":[{"name":"/amember/oauth/token","id":"172865de-d4d3-4bb6-b6fa-f7879c9e86d6","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )
\n","key":"client_id","type":"text","value":"CLIENT_ID"},{"description":"Oauth Client Secret (autogenerated value available once you create client)
\n","key":"client_secret","type":"text","value":"CLIENT_SECRET"},{"description":"Grant Type is client_credentials for this request
\n","key":"grant_type","type":"text","value":"client_credentials"},{"description":"List of requested scopes. Scopes are unique for each endpoint. Do not request more scopes then necessary.
\n","key":"scope","type":"text","value":"rest.users.index"},{"description":"User's login. Access token will gant an access to user's account. All future reuests will be process on behalf of this user.
\n","key":"username","type":"text","value":"USERNAME","disabled":true},{"description":"User's password
\n","key":"password","type":"text","value":"PASSWORD","disabled":true}]},"url":"http://localhost/amember/oauth/token","description":"Exchange client login credentials to access token.
\n","urlObject":{"protocol":"http","path":["amember","oauth","token"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e7146ca2-ce20-422b-965c-81faf14bb46f","name":"Grant Type: client_credentials, Get Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )","key":"client_id","type":"text","value":"325bd0e28b82b1f"},{"description":"Oauth Client Secret (autogenerated value available once you create client)","key":"client_secret","type":"text","value":"429b412525a15d87a87b295ed095f99498849b4248c0c4400c2a93c486289ecf"},{"description":"Grant Type is *client_credentials* for this request","key":"grant_type","type":"text","value":"client_credentials"},{"description":"List of requested scopes. Scopes are unique for each endpoint. Do not request more scopes then necessary.\n","key":"scope","type":"text","value":"rest.users.index"},{"description":"User's login. Access token will gant an access to user's account. All future reuests will be process on behalf of this user. ","key":"username","type":"text","value":"USERNAME","disabled":true},{"description":"User's password","key":"password","type":"text","value":"PASSWORD","disabled":true}]},"url":"http://example.com/amember/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Nov 2018 20:45:48 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1070"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 12959999,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjdiNWYyNmY2ZTExM2FhNGQ1ZmY3MTgyMTFmODIzMmMzNmFhZDMwMDQ0ZDMzZDRiZWY5MzljYTEyZWNjZjRkZDNkZTIyNDg1ZTFmYjc4Zjc0In0.eyJhdWQiOiIzMjViZDBlMjhiODJiMWYiLCJqdGkiOiI3YjVmMjZmNmUxMTNhYTRkNWZmNzE4MjExZjgyMzJjMzZhYWQzMDA0NGQzM2Q0YmVmOTM5Y2ExMmVjY2Y0ZGQzZGUyMjQ4NWUxZmI3OGY3NCIsImlhdCI6MTU0MTcwOTk0OSwibmJmIjoxNTQxNzA5OTQ5LCJleHAiOjE1NTQ2Njk5NDgsInN1YiI6IiIsInNjb3BlcyI6W119.RWXBaQr9Uvkm2F4wLKSS3PvhLyiXisa3CJw_wIP69iFmWW0pu1BGuMLwADCN9_QUbjx6HjzKAHWBGzjTliBjRwFHvS-t-U7cSyeS1PxIJPf_jrK4U3YoGPUIv9oWnOQ69eAE76iUDx5_9Q8Q_JEH0eWp9BS2ZHB_G1fRYi613d_DwJjiHRsNwXFysI7tjamp9_i2z0paTFOGGKhXAQCIfaCyYpdkIt6W-MERAMI7MKOtIIH-mkTlfJZF6dh_TMZLKpzlmLA3SIpZ07cv0UXTW-iV-DnOOCDLP-WuBkUYbYs7eFtud2u_Iuo6gcRUOXLkWIIu0LejnITuxQknXi2TEA\"\n}"}],"_postman_id":"172865de-d4d3-4bb6-b6fa-f7879c9e86d6"}],"id":"b293654f-0983-4c28-b902-f787acf593f6","description":"Implements an ability to exchange oAuth client credentials to access token. \nThis grant is useful for server to server api request. Should be used on trusted systems only.
\n","event":[{"listen":"prerequest","script":{"id":"282e20dc-ba2c-4b65-80f3-f38ed23bd0a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5ece96b3-b840-4cdb-aef1-abb0136be312","type":"text/javascript","exec":[""]}}],"_postman_id":"b293654f-0983-4c28-b902-f787acf593f6"},{"name":"Grant Type: amember_device","item":[{"name":"/amember/oauth/token","id":"30983f35-a5bb-43b2-8ed6-f2fbfbe9934d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )
\n","key":"client_id","type":"text","value":"7ddf442f82f5ec31053f1a623225c001"},{"description":"ID of registered device
\n","key":"amember_device_id","type":"text","value":"0be8b3c934c0be1c3593e80a6cfadc83439f12943281f492d52d912389143be0"},{"description":"Grant Type is amember_device for this request
\n","key":"grant_type","type":"text","value":"amember_device"},{"key":"scope","value":"paysystems register available-products","description":"List of requested scopes
\n","type":"text"}]},"url":"http://example.com/amember/oauth/token","description":"Exchange client_id and amember_device_id to access token.
\n","urlObject":{"protocol":"http","path":["amember","oauth","token"],"host":["example","com"],"query":[],"variable":[]}},"response":[{"id":"f824c31c-46ff-4aae-97cd-a65acc14f4b0","name":"GET access token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )","key":"client_id","type":"text","value":"838f5bc4302cf62a15c1f232f902423f"},{"description":"ID of registered device","key":"amember_device_id","type":"text","value":"2343425342534254325342"},{"description":"Grant Type is *client_credentials* for this request","key":"grant_type","type":"text","value":"amember_device"},{"description":"List of requested scopes. Scopes are unique for each endpoint. Do not request more scopes then necessary.\n","key":"scope","type":"text","value":"rest.users.index","disabled":true},{"description":"User's login. Access token will gant an access to user's account. All future reuests will be process on behalf of this user. ","key":"username","type":"text","value":"USERNAME","disabled":true},{"description":"User's password","key":"password","type":"text","value":"PASSWORD","disabled":true}]},"url":"http://example.com/amember/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 12:43:18 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"840"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"scope\": \"\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjQ4MDEyZWM0ZDBkZTQyYmM3NDE4OTk0M2Y5NTUxM2Y2YzcyNjZmYTllZjhhYzQzZmE0MmRjNzNmYTlhOGU1YjI3NjY2MTE3NmM2ZjdhZmFjIn0.eyJhdWQiOiI4MzhmNWJjNDMwMmNmNjJhMTVjMWYyMzJmOTAyNDIzZiIsImp0aSI6IjQ4MDEyZWM0ZDBkZTQyYmM3NDE4OTk0M2Y5NTUxM2Y2YzcyNjZmYTllZjhhYzQzZmE0MmRjNzNmYTlhOGU1YjI3NjY2MTE3NmM2ZjdhZmFjIiwiaWF0IjoxNTQ1MzA5Nzk4LCJuYmYiOjE1NDUzMDk3OTgsImV4cCI6MTU0NTMxMzM5OCwic3ViIjoiIiwic2NvcGVzIjpbXX0.vfPpevwZmr2bS41digww8-yee2dZ6C1gi3qPUY9KPNecn1j30nkSMEdFB7Uk3yHKDZui_7EpuFX9LcvU2XLiRrMRJ5OaMkiT-KaEmkF5L6L5IqD1IXFk-Z23pbxqkxQQxiTiC5U6yE8vf9TCv4rvpiksWaK0GuzqZ_idStm30hvtMVuJhHc8NY9ekVvV-SUUsx3d8ZyFmKYXxdaHF7aoe_mJRlYo0IDZWQW-Ts1pxDH6jBvf3OEIuXyqKhOZ7M6_NwG1SwJ0jRD8USJA0VJvxZpHBpP83vlRWJA8YOPw17YAAYnjHw7zvFl2bRt-zI4rxno-IoxAQXAsoEItPxC76A\"\n}"}],"_postman_id":"30983f35-a5bb-43b2-8ed6-f2fbfbe9934d"}],"id":"cefe27c1-c2e7-4696-8db0-31674d2ab037","description":"Could be used to provide an access to public endpoints. \namember_device_id and client_id will be exchanged to access token, device should be registered first, \nsee register-device api call
\n","event":[{"listen":"prerequest","script":{"id":"282e20dc-ba2c-4b65-80f3-f38ed23bd0a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5ece96b3-b840-4cdb-aef1-abb0136be312","type":"text/javascript","exec":[""]}}],"_postman_id":"cefe27c1-c2e7-4696-8db0-31674d2ab037"},{"name":"Grant Type: authorization_code","item":[{"name":"/amember/oauth/authorize","id":"4e0dae34-39a6-4331-bbf6-2530d92fcc2b","request":{"method":"GET","header":[],"url":"http://example.com/amember/oauth/authorize?response_type=code&client_id=325bd0e28b82b1f&redirect_uri=http://localhost/amember&scope=me.fullprofile&state=fdhjks","description":"The client should redirect the user to the authorization server with the following parameters in the query string:
\n","urlObject":{"protocol":"http","path":["amember","oauth","authorize"],"host":["example","com"],"query":[{"description":{"content":"Should be set to code
\n","type":"text/plain"},"key":"response_type","value":"code"},{"description":{"content":"Oauth Client ID (create it in aMember CP -> Oauth Clients )
\n","type":"text/plain"},"key":"client_id","value":"325bd0e28b82b1f"},{"description":{"content":"Authorized Redirect URI configured for client. Should be exactly the same as in client settings.
\n","type":"text/plain"},"key":"redirect_uri","value":"http://localhost/amember"},{"description":{"content":"List of requested scopes
\n","type":"text/plain"},"key":"scope","value":"me.fullprofile"},{"description":{"content":"CSRF Token. Will be stored by server and passed back to verify.
\n","type":"text/plain"},"key":"state","value":"fdhjks"}],"variable":[]}},"response":[],"_postman_id":"4e0dae34-39a6-4331-bbf6-2530d92fcc2b"},{"name":"/amember/oauth/token","id":"a2b0ec91-8181-4114-aa3d-6ed97b6812a9","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"authorization_code","description":"Should be set to authorization_code for this request
\n","type":"text"},{"key":"client_id","value":"325bd0e28b82b1f","description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )
\n","type":"text"},{"key":"client_secret","value":"429b412525a15d87a87b295ed095f99498849b4248c0c4400c2a93c486289ecf","description":"Oauth Client Secret (autogenerated value available once you create client)
\n","type":"text"},{"key":"redirect_uri","value":"http://localhost/amember","description":"Original redirect URI that was send to authorization server in authorize request.
\n","type":"text"},{"key":"code","value":"**CODE**","description":"Authorization code received from authorization server
\n","type":"text"}]},"url":"http://localhost/amember/oauth/token","description":"Exchange received authorization code to access token.
\n","urlObject":{"protocol":"http","path":["amember","oauth","token"],"host":["localhost"],"query":[{"disabled":true,"description":{"content":"Should be set to authorization_code for this request
\n","type":"text/plain"},"key":"grant_type","value":"authorization_code"},{"disabled":true,"description":{"content":"Oauth Client ID (create it in aMember CP -> Oauth Clients )
\n","type":"text/plain"},"key":"client_id","value":"325bd0e28b82b1f"},{"disabled":true,"description":{"content":"Oauth Client Secret (autogenerated value available once you create client)
\n","type":"text/plain"},"key":"client_secret","value":"429b412525a15d87a87b295ed095f99498849b4248c0c4400c2a93c486289ecf"},{"disabled":true,"description":{"content":"Original redirect URI that was send to authorization server in authorize request.
\n","type":"text/plain"},"key":"redirect_uri","value":"http://localhost/amember"},{"disabled":true,"key":"code","value":""}],"variable":[]}},"response":[{"id":"4d8046f2-0b36-42cd-beca-af5f424ed94e","name":"/amember/oauth/token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"authorization_code","description":"Should be set to *authorization_code* for this request","type":"text"},{"key":"client_id","value":"325bd0e28b82b1f","description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )","type":"text"},{"key":"client_secret","value":"429b412525a15d87a87b295ed095f99498849b4248c0c4400c2a93c486289ecf","description":"Oauth Client Secret (autogenerated value available once you create client)","type":"text"},{"key":"redirect_uri","value":"http://localhost/amember","description":"Original redirect URI that was send to authorization server in authorize request. \n","type":"text"},{"key":"code","value":"def502008efb62d6cb2057ddad16c03f03ab7d6760682accb8455f73a362199f5e1ca579ed9178aaee48efe7925d625431f21f73b610d418151dfc89b39bfc207098ef625b5d1f08fbffd42b5bd24543c467d3eb257c3f05880eaae1138387a9dfdaab1afb21eec950aa0fc819faa57a5652d8a8f8b19da855c12fecbc7d78fae270b6f9b7a15ba6e100c8f0f9cbe84af4340cffa768e8d8229395e48dcd293936bdb9d8e7d6ffccbeafcae807920733f5cd5d96d6516d6dd5e4b9e3e79c92baaa19df7297789a2fedafc678d07658c918e01be1edf79d49443a780465b77681bc0e711ed40f5bc0450fa7d86385e7623f5fd9e7b051356967aa457ec6d451bfaf8cbcd8695cb7945734e0f59b18ad17bf4ba4bc1c961f74be1ccb5afa4a8d47366bb5b4e8debbf7a392ffce1da39a355c8748769cf9c110c7d6d4b8f6706a9a5e4ba6d9a46d41baad3ca7cd08a53c53fb00b643c712d917b483dd0e4c76e17ed62674d4acfeb27e7163a8827a6808362bf17aac0c46bc9505201cc039","description":"Authorization code received from authorization server","type":"text"}]},"url":{"raw":"http://example/amember/oauth/token","protocol":"http","host":["example"],"path":["amember","oauth","token"],"query":[{"key":"grant_type","value":"authorization_code","description":"Should be set to *authorization_code* for this request","type":"text","disabled":true},{"key":"client_id","value":"325bd0e28b82b1f","description":"Oauth Client ID (create it in aMember CP -> Oauth Clients )","type":"text","disabled":true},{"key":"client_secret","value":"429b412525a15d87a87b295ed095f99498849b4248c0c4400c2a93c486289ecf","description":"Oauth Client Secret (autogenerated value available once you create client)","type":"text","disabled":true},{"key":"redirect_uri","value":"http://localhost/amember","description":"Original redirect URI that was send to authorization server in authorize request. \n","type":"text","disabled":true},{"key":"code","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 15 Nov 2018 00:51:10 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1661"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"scope\": \"me.fullprofile\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 12959999,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijg2NjJiMTFmZGVlODMyYjgwOGRjMjgyZjExYTZjYmNmZWZiZDE4Nzk4OWIyMGViY2M1NjM2YjdhOTcxNjkzNGUzM2U4N2FjMTdlYmJjZTM4In0.eyJhdWQiOiIzMjViZDBlMjhiODJiMWYiLCJqdGkiOiI4NjYyYjExZmRlZTgzMmI4MDhkYzI4MmYxMWE2Y2JjZmVmYmQxODc5ODliMjBlYmNjNTYzNmI3YTk3MTY5MzRlMzNlODdhYzE3ZWJiY2UzOCIsImlhdCI6MTU0MjI0MzA3MSwibmJmIjoxNTQyMjQzMDcxLCJleHAiOjE1NTUyMDMwNzAsInN1YiI6IjM3MjMiLCJzY29wZXMiOlsibWUuZnVsbHByb2ZpbGUiXX0.ERutyU-8Xuz0fycZQ96CcarIzFmvAiqss-sODQyKJWOMg4b3lpmN0aeZG17O7l9VXRUHrgIIuuWwFRpes3tcY7GlCz1azfqGSIcydj2g9B-bCfW5ipiGnF2JsymgwtuJ9sFu3gTQObEcr5GKDSJ9kT7Qi5I2wjLDTU3whc6oGpbVz_jdbutM_KRyu5R67UTA5Gx2jeS-0HYOHIx60v-6SGgsd3RO8tFoYcHbFrDbhZhRPPEuzDnx6_uonGf8eYlxEPYWbuffyeg_Vxly-qgOSRF5Y8ZecOpSxVPD4VNscd27K2FjmDVXewUGuFmERBjmnpOC6JVm28HIZi3oFsiu-g\",\n \"refresh_token\": \"def50200e9c89e7509300f7fff90f9fef3f1c4d6060b43df6cec765b35e263d9a8bcc7f01ca5f76bd1ab77f7b069f723d0a4301d1186710e71ba8a576f545b5d750bbbcf6502f306bb584f3462b6a5a099ce8574a8513df5cf01c9c11f821243ab21d39185b515065f2efe646caee462ea14432a4d96b944bd1759d4eee2daaba48251b52ab78aecd45b734b74e1f38690640cc00f53548b7434e967b93dd8c1fb7e8fd6ba793c927e57d608237ce8db3fba6ebd1af73f636395b0d6dd276199c5f0e2a632777188d5d9b2ba4522f19f593033ee256df4c9f5b0bd269200330c1ed6982d292f72ee3a82f88ab87142e0b520a7dbc560f58dfff871c6a47deeeffa34d228c97f04d9d4575aff925dad1fc5735d290c19f98b9f3cde0fa75e51988e86fe14081fd6c50fa69c5d9f71d6f46ff76c9fd5a16d538869a8eb50d03a3e77bff93113bee1480097b27849925ffb1edb237c5e075fd04fb829a99a61e00f74498e4ba2029ef7eb3ab9277fca519be033780c5a2836ea29475440799c3cd3f68bd439d02a\"\n}"}],"_postman_id":"a2b0ec91-8181-4114-aa3d-6ed97b6812a9"}],"id":"a0332b86-3de8-4c9d-bce7-9d4551462eb1","description":"The authorization_code grant type is used by private and public clients to exchange an authorization code for an access token.
\nProcess is two steps: \n 1. Client redirects user to authorization endpoint, where user have to accept/deny application access. \n If access was authorized, user is being sent back to redirect_uri \n Authorization code parameter will be passed in query string: http://example.com?code=AUTHORIZATION_CODE\n 2. Client exchange that code to access_token
\n","event":[{"listen":"prerequest","script":{"id":"4c9d4151-f166-4e81-a7cc-61c1a3168266","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7673ac5e-ee36-4be6-b3be-907c28c292eb","type":"text/javascript","exec":[""]}}],"_postman_id":"a0332b86-3de8-4c9d-bce7-9d4551462eb1"}],"id":"129a3c7d-c102-48a5-9044-9a021164183b","_postman_id":"129a3c7d-c102-48a5-9044-9a021164183b","description":""},{"name":"API2 Endpoints","item":[{"name":"User Endpoints","item":[{"name":"/amember/api2/agreement","id":"0cc4f43e-b63a-4a5f-bc3c-1e9e681df52b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Retrieve list of current agreement documents(Privacy Policy, Terms & Conditions, etc...)
\nSupported Scopes
\n\\r\\nWe pay a lot of commissions\",\n \"dattm\": \"2018-05-29 14:51:59\",\n \"is_current\": \"1\",\n \"comment\": \"\"\n },\n \"agreement-signup-default\": {\n \"agreement_revision_id\": 19,\n \"type\": \"agreement-signup-default\",\n \"title\": \"Terms & Conditions\",\n \"url\": \"\",\n \"body\": \"Agreement body\",\n \"dattm\": \"2018-05-29 15:04:49\",\n \"is_current\": \"1\",\n \"comment\": \"Latest version use it\"\n }\n }\n}"}],"_postman_id":"0cc4f43e-b63a-4a5f-bc3c-1e9e681df52b"},{"name":"/amember/api2/user/consent","id":"a0290d83-a13e-4067-bc5c-bb0eb7bc5caf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"
Get user consent. Return list of all user consent records for current documents.
\nSupported Scopes
\nDocument type. See \"agreement\" endpoint
\n","type":"text"}]},"url":"http://example.com/amember/api2/user/consent","description":"Record user consent
\nSupported Scopes
\nuser Consent to be cancelled
\n","type":"text"}]},"url":"http://example.com/amember/api2/user/consent","description":"Cancel user consent
\nSupported Scopes
\nUser's password. Must be sent in order to validate request
\n","type":"text"}]},"url":"http://example.com/amember/api2/user/personal-data","description":"Get User's personal data.
\nSupported Scopes
\nUser's password to validate request
\n","type":"text"}]},"url":"http://example.com/amember/api2/user/personal-data","description":"Delete User's Personal Data. \nPlease note: User's account will be anonymized. User's access token and auth codes will be revoked. \nIf there was an errors in data anonymization process these errors will be returned.
\nSupported Scopes
\nGet user Profile information. \nOnly fields included in oauth-profile form that you have set in aMember CP -> Forms Editor -> Edit Form will be returned
\nSupported Scopes
\nEmail address
\n","type":"text"},{"key":"name_f","value":"Test","description":"First name
\n","type":"text"},{"key":"name_l","value":"Test","description":"Last name
\n","type":"text"},{"key":"pass","value":"testtest","description":"Password
\n","type":"text"},{"key":"login","value":"sanja","type":"text","disabled":true}]},"url":"http://example.com/amember/api2/user/profile","description":"Update profile information Incoming request will be validated according to oauth-profile form settings. \nIf email confirmation is required, validation email will be sent to user's email address. \nuser's account will be marked as not confirmed. ( user.email_confirmed = false )
\nSupported Scopes
\nGet all user's access records
\nSupported Scopes
\nResend confirmation message to user's email address. By default, if you enable email confirmation in aMember CP -> Edit Forms for oauth-register form's email brick, message will be sent automatically when you register user's account. \nThat action allow to re-send message and re-generate verification code. New code will be sent to user's email address. \nIf users' email address was confirmed already, message will not be sent but API will return sucecss response.
\nSupported Scopes
\nConfirmatio ncode received by email
\n","key":"code","type":"text","value":"612580"}]},"url":"http://example.com/amember/api2/user/confirm-email","description":"Confirm user's email address. \nIn confirmation email message, user get confirmation code that could be used to confirm email address via API. \nThis endpoint accept confirmation code and mark user's email address as confirmed if code is correct.
\nSupported Scopes
\nEndpoints related to user record
\n","_postman_id":"c6bf29e2-42f6-4f89-9e85-9a45261d450d"},{"name":"Manage User's invoices","item":[{"name":"/amember/api2/user/invoice","id":"45cf17fc-0edf-499f-a074-48cbcd8a62b2","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Retrieve all user's invoices or single invoice and associated access, payment, refund records.
\nIf invoice has pending satus, received invoice object will have paymentLink propertly, that is url of payment page for this invoice.
\nSupported Scopes
\nID of product in amember Cntrol Panel
\n","type":"text"},{"key":"products[0][billing_plan_id]","value":"5","description":"(optional) ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used
\n","type":"text"},{"key":"products[0][qty]","value":"1","description":"(optional) Product quantity. If product doesn't allow to change quantity, it will be set to 1
\n","type":"text"},{"key":"paysys_id","value":"cc-demo","description":"Paysystem ID used for invoice. You can get it from /amember/api2/paysystems call
\n","type":"text"},{"key":"coupon","value":"UR2W4U2S","description":"Couponj code specified by customer
\n","type":"text"}]},"url":"http://example.com/amember/api2/user/invoice","description":"Create Invoice record.
\nThis call will execute all hooks related to invoice(so pending invoice notificatons will be sent).
\nIf you add only free products to invoice, it will be set as completed. \nEndpoint accept form data post or json object as input, please see examples for details.
\nSupported Scopes
\nID of product in amember Cntrol Panel
\n","type":"text/plain"},"key":"products[0][product_id]","value":"5"},{"disabled":true,"description":{"content":"(optional) ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used
\n","type":"text/plain"},"key":"products[0][billing_plan_id]","value":"5"},{"disabled":true,"description":{"content":"(optional) Product quantity. If product doesn't allow to change quantity, it will be set to 1
\n","type":"text/plain"},"key":"products[0][qty]","value":"1"},{"disabled":true,"description":{"content":"Paysystem ID You can get it from /amember/api2/paysystems call
\n","type":"text/plain"},"key":"paysys_id","value":"cc-demo"},{"disabled":true,"description":{"content":"(optional) Coupon code
\n","type":"text/plain"},"key":"coupon","value":"UR2W4U2S"}],"variable":[]}},"response":[{"id":"1806f04c-4e38-46b8-a8fe-d93c5bded174","name":"Example of pending invocie with with payment link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"products[0][product_id]","value":"5","description":"ID of product in amember Cntrol Panel ","type":"text"},{"key":"products[0][billing_plan_id]","value":"5","description":"*(optional)* ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used\n","type":"text"},{"key":"products[0][qty]","value":"1","description":"*(optional)* Product quantity. If product doesn't allow to change quantity, it will be set to 1\n","type":"text"},{"key":"paysys_id","value":"cc-demo","description":"Paysystem ID used for invoice. You can get it from /amember/api2/paysystems call","type":"text"},{"key":"coupon","value":"UR2W4U2S","description":"Couponj code specified by customer","type":"text"}]},"url":{"raw":"http://example.com/amember/api2/user/invoice","protocol":"http","host":["example","com"],"path":["amember","api2","user","invoice"],"query":[{"key":"products[0][product_id]","value":"5","description":"ID of product in amember Cntrol Panel ","disabled":true},{"key":"products[0][billing_plan_id]","value":"5","description":"*(optional)* ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used","disabled":true},{"key":"products[0][qty]","value":"1","description":"*(optional)* Product quantity. If product doesn't allow to change quantity, it will be set to 1\n","disabled":true},{"key":"paysys_id","value":"cc-demo","description":"Paysystem ID You can get it from /amember/api2/paysystems call","disabled":true},{"key":"coupon","value":"UR2W4U2S","description":"*(optional)* Coupon code","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 17 Nov 2018 09:13:53 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"2090"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"invoice_id\": 1218,\n \"user_id\": \"3723\",\n \"paysys_id\": \"cc-demo\",\n \"currency\": \"USD\",\n \"first_subtotal\": \"183.00\",\n \"first_discount\": \"18.30\",\n \"first_tax\": \"0.00\",\n \"first_shipping\": \"0.00\",\n \"first_total\": \"164.70\",\n \"first_period\": \"1y\",\n \"rebill_times\": \"99999\",\n \"second_subtotal\": \"183.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_shipping\": \"0.00\",\n \"second_total\": \"183.00\",\n \"second_period\": \"1y\",\n \"tax_rate\": null,\n \"tax_type\": null,\n \"tax_title\": null,\n \"status\": \"0\",\n \"coupon_id\": \"2\",\n \"is_confirmed\": \"1\",\n \"is_cancelled\": null,\n \"public_id\": \"T8RZX\",\n \"invoice_key\": \"HwrvbBWujYVoGhWK\",\n \"tm_added\": \"2018-11-17 13:13:53\",\n \"tm_started\": null,\n \"tm_cancelled\": null,\n \"rebill_date\": null,\n \"comment\": null,\n \"base_currency_multi\": \"1.000000\",\n \"coupon_code\": \"UR2W4U2S\",\n \"due_date\": null,\n \"aff_id\": null,\n \"discount_first\": \"0.00\",\n \"discount_second\": \"0.00\",\n \"terms\": null,\n \"saved_form_id\": null,\n \"keyword_id\": null,\n \"remote_addr\": \"::1\",\n \"paymentLink\": \"http://localhost/amember/payment/cc-demo/cc?id=T8RZX-a9f586d24905d08c\",\n \"items\": [\n {\n \"invoice_item_id\": 1332,\n \"invoice_id\": \"1218\",\n \"item_id\": \"5\",\n \"item_type\": \"product\",\n \"item_title\": \"Training rename test\",\n \"item_description\": \"Short description of this subscription\",\n \"qty\": \"1\",\n \"first_price\": \"183.00\",\n \"first_discount\": \"18.30\",\n \"first_tax\": \"0.00\",\n \"first_total\": \"164.70\",\n \"first_shipping\": \"0.00\",\n \"first_period\": \"1y\",\n \"rebill_times\": \"99999\",\n \"second_price\": \"183.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_total\": \"183.00\",\n \"second_shipping\": \"0.00\",\n \"second_period\": \"1y\",\n \"currency\": \"USD\",\n \"no_tax\": null,\n \"trial_group\": null,\n \"renewal_group\": null,\n \"is_countable\": \"0\",\n \"is_tangible\": null,\n \"billing_plan_id\": \"5\",\n \"billing_plan_data\": \"a:4:{s:9:\\\"paypal_id\\\";s:0:\\\"\\\";s:16:\\\"safecart_product\\\";s:0:\\\"\\\";s:12:\\\"safecart_sku\\\";s:0:\\\"\\\";s:16:\\\"wsopro_item_name\\\";s:0:\\\"\\\";}\",\n \"option1\": null,\n \"option2\": null,\n \"option3\": null,\n \"variable_qty\": \"0\",\n \"tax_group\": null,\n \"invoice_public_id\": \"T8RZX\",\n \"options\": \"[]\",\n \"tax_rate\": null\n }\n ],\n \"payments\": [],\n \"refunds\": [],\n \"access\": []\n }\n}"},{"id":"52746019-ee16-4f54-9552-f1b40d9ee87f","name":"Example of invoice with one free product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"products","value":"8","description":"ID of product in amember Cntrol Panel ","type":"text"},{"key":"products[0][billing_plan_id]","value":"8","description":"*(optional)* ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used\n","type":"text","disabled":true},{"key":"products[0][qty]","value":"1","description":"*(optional)* Product quantity. If product doesn't allow to change quantity, it will be set to 1\n","type":"text","disabled":true},{"key":"paysys_id","value":"cc-demo","description":"Paysystem ID used for invoice. You can get it from /amember/api2/paysystems call","type":"text","disabled":true},{"key":"coupon","value":"UR2W4U2S","description":"Couponj code specified by customer","type":"text","disabled":true}]},"url":{"raw":"http://example.com/amember/api2/user/invoice","protocol":"http","host":["example","com"],"path":["amember","api2","user","invoice"],"query":[{"key":"products[0][product_id]","value":"5","description":"ID of product in amember Cntrol Panel ","disabled":true},{"key":"products[0][billing_plan_id]","value":"5","description":"*(optional)* ID of Billing Plan You can get such ID from /amember/api2/available-products request. In ommited, default billing plan will be used","disabled":true},{"key":"products[0][qty]","value":"1","description":"*(optional)* Product quantity. If product doesn't allow to change quantity, it will be set to 1\n","disabled":true},{"key":"paysys_id","value":"cc-demo","description":"Paysystem ID You can get it from /amember/api2/paysystems call","disabled":true},{"key":"coupon","value":"UR2W4U2S","description":"*(optional)* Coupon code","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 17 Nov 2018 09:15:58 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1976"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"invoice_id\": 1219,\n \"user_id\": \"3723\",\n \"paysys_id\": \"free\",\n \"currency\": \"USD\",\n \"first_subtotal\": \"0.00\",\n \"first_discount\": \"0.00\",\n \"first_tax\": \"0.00\",\n \"first_shipping\": \"0.00\",\n \"first_total\": \"0.00\",\n \"first_period\": \"30d\",\n \"rebill_times\": \"0\",\n \"second_subtotal\": \"0.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_shipping\": \"0.00\",\n \"second_total\": \"0.00\",\n \"second_period\": null,\n \"tax_rate\": null,\n \"tax_type\": null,\n \"tax_title\": null,\n \"status\": 1,\n \"coupon_id\": null,\n \"is_confirmed\": \"1\",\n \"is_cancelled\": null,\n \"public_id\": \"SJUG6\",\n \"invoice_key\": \"sMDdGu9VqeBFBdbf\",\n \"tm_added\": \"2018-11-17 13:15:59\",\n \"tm_started\": \"2018-11-17 13:15:59\",\n \"tm_cancelled\": null,\n \"rebill_date\": null,\n \"comment\": null,\n \"base_currency_multi\": \"1.000000\",\n \"coupon_code\": null,\n \"due_date\": null,\n \"aff_id\": null,\n \"discount_first\": \"0.00\",\n \"discount_second\": \"0.00\",\n \"terms\": null,\n \"saved_form_id\": null,\n \"keyword_id\": null,\n \"remote_addr\": \"::1\",\n \"items\": [\n {\n \"invoice_item_id\": 1333,\n \"invoice_id\": \"1219\",\n \"item_id\": \"8\",\n \"item_type\": \"product\",\n \"item_title\": \"Testik\",\n \"item_description\": \"\",\n \"qty\": \"1\",\n \"first_price\": \"0.00\",\n \"first_discount\": \"0.00\",\n \"first_tax\": \"0.00\",\n \"first_total\": \"0.00\",\n \"first_shipping\": \"0.00\",\n \"first_period\": \"30d\",\n \"rebill_times\": \"0\",\n \"second_price\": \"0.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_total\": \"0.00\",\n \"second_shipping\": \"0.00\",\n \"second_period\": null,\n \"currency\": \"USD\",\n \"no_tax\": null,\n \"trial_group\": null,\n \"renewal_group\": null,\n \"is_countable\": \"0\",\n \"is_tangible\": null,\n \"billing_plan_id\": \"8\",\n \"billing_plan_data\": \"a:2:{s:16:\\\"safecart_product\\\";s:0:\\\"\\\";s:12:\\\"safecart_sku\\\";s:0:\\\"\\\";}\",\n \"option1\": null,\n \"option2\": null,\n \"option3\": null,\n \"variable_qty\": \"0\",\n \"tax_group\": null,\n \"invoice_public_id\": \"SJUG6\",\n \"options\": \"[]\",\n \"tax_rate\": null\n }\n ],\n \"payments\": [],\n \"refunds\": [],\n \"access\": [\n {\n \"access_id\": 3517,\n \"invoice_id\": \"1219\",\n \"invoice_payment_id\": null,\n \"user_id\": \"3723\",\n \"product_id\": \"8\",\n \"transaction_id\": \"::1-1542446159\",\n \"begin_date\": \"2018-11-17\",\n \"expire_date\": \"2018-12-17\",\n \"qty\": \"1\",\n \"invoice_item_id\": \"1333\",\n \"comment\": null,\n \"invoice_public_id\": \"SJUG6\"\n }\n ]\n }\n}"}],"_postman_id":"c27144a2-504e-437f-93d5-5390457d3574"},{"name":"/amember/api2/user/invoice/[invoice_id]","id":"b73f6793-e69f-4cf1-8ea2-1f93463ac974","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Products to include in invoice. Please note that products will be replaced. So you need to include all products again.
\n"},{"key":"paysys_id","value":"stripe","type":"text","description":"Update paysystem
\n"},{"key":"coupon","value":"UR2W4U2S","type":"text","description":"Update coupon
\n"}]},"url":"http://example.com/amember/api2/user/invoice/[invoice_id]","description":"Update invoice record.
\nYou can update pending invoice record and change products in invoice, coupon code and paysystem. Attempt to update completed invoice will generate an error.
\nIf you add only free products to invoice, it will be set as completed. \nEndpoint accept form data post or json object as input, please see examples for details.
\nSupported Scopes
\nSetup charge on user's invoice using payment token obtained externaly.
\nReal payment will be processed. All aMember's hooks will be executed, so user will receive all necessary emails and will be added to all linked thrid-party scripts.
\nThat is possible to run rebills through that hook too. \nCall charge endpoint without token, aMember will setup charge using token stored in invoice record. Please note that charge can't be executed before actual rebill_date.
\nInformation about charge is available in data.chargeResult object. Please see examples.
\nSupported Scopes
\nCancel recurring invoice. \naMember will try to submit cancellation request to payment system and cancel invoice. \nIf request was seccessful, invoice will be cancelled and client will receive OK responce. \nIf user should be redirected to payment system for cancellation status=>redirect response will be received.
\n","urlObject":{"protocol":"http","path":["amember","api2","user","invoice","1738846"],"host":["example","com"],"query":[],"variable":[]}},"response":[{"id":"c2052d70-99fe-4025-82b7-dca3a140e98d","name":"Successful Cancellation","originalRequest":{"method":"DELETE","header":[],"url":"http://example.com/amember/api2/user/invoice/1738845"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Nov 2018 13:08:23 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"3122"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"invoice_id\": 1738845,\n \"user_id\": \"883051\",\n \"paysys_id\": \"cc-demo\",\n \"currency\": \"EUR\",\n \"first_subtotal\": \"2.00\",\n \"first_discount\": \"0.00\",\n \"first_tax\": \"0.00\",\n \"first_shipping\": \"0.00\",\n \"first_total\": \"2.00\",\n \"first_period\": \"1m\",\n \"rebill_times\": \"99999\",\n \"second_subtotal\": \"2.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_shipping\": \"0.00\",\n \"second_total\": \"2.00\",\n \"second_period\": \"1m\",\n \"tax_rate\": null,\n \"tax_type\": null,\n \"tax_title\": null,\n \"status\": \"3\",\n \"coupon_id\": null,\n \"coupon_code\": null,\n \"is_confirmed\": \"1\",\n \"public_id\": \"7CMJ5\",\n \"invoice_key\": \"FF7yyA0vNZe2T928\",\n \"tm_added\": \"2018-11-20 17:06:00\",\n \"tm_started\": \"2018-11-20 17:06:00\",\n \"tm_cancelled\": \"2018-11-20 17:08:23\",\n \"rebill_date\": null,\n \"due_date\": null,\n \"comment\": \"\",\n \"base_currency_multi\": \"1.000000\",\n \"aff_id\": null,\n \"campaign_id\": null,\n \"saved_form_id\": null,\n \"keyword_id\": null,\n \"discount_first\": \"0.00\",\n \"discount_second\": \"0.00\",\n \"terms\": null,\n \"paypal_account\": null,\n \"remote_addr\": \"127.0.0.1\",\n \"items\": [\n {\n \"invoice_item_id\": 3287810,\n \"invoice_id\": \"1738845\",\n \"invoice_public_id\": \"7CMJ5\",\n \"item_id\": \"203\",\n \"item_type\": \"product\",\n \"item_title\": \"Main product\",\n \"item_description\": \"test message\\r\\ntest message\",\n \"qty\": \"1\",\n \"first_price\": \"2.00\",\n \"first_discount\": \"0.00\",\n \"first_tax\": \"0.00\",\n \"first_total\": \"2.00\",\n \"first_shipping\": \"0.00\",\n \"first_period\": \"1m\",\n \"rebill_times\": \"99999\",\n \"second_price\": \"2.00\",\n \"second_discount\": \"0.00\",\n \"second_tax\": \"0.00\",\n \"second_total\": \"2.00\",\n \"second_shipping\": \"0.00\",\n \"second_period\": \"1m\",\n \"currency\": \"EUR\",\n \"tax_group\": null,\n \"is_countable\": \"0\",\n \"variable_qty\": \"0\",\n \"is_tangible\": null,\n \"billing_plan_id\": \"203\",\n \"billing_plan_data\": \"a:16:{s:16:\\\"1shoppingcart_id\\\";s:0:\\\"\\\";s:11:\\\"avangate_id\\\";s:0:\\\"\\\";s:18:\\\"ccbill_flexform_id\\\";s:0:\\\"\\\";s:14:\\\"ccbill_form_id\\\";s:0:\\\"\\\";s:17:\\\"ccbill_product_id\\\";s:0:\\\"\\\";s:20:\\\"ccbill_subaccount_id\\\";s:0:\\\"\\\";s:20:\\\"clickbank_product_id\\\";s:0:\\\"\\\";s:17:\\\"clickbank_skin_id\\\";s:0:\\\"\\\";s:15:\\\"clickfunnels_id\\\";s:0:\\\"\\\";s:16:\\\"epoch_product_id\\\";s:0:\\\"\\\";s:17:\\\"epoch_site_subcat\\\";s:0:\\\"\\\";s:21:\\\"fastspring_product_id\\\";s:0:\\\"\\\";s:23:\\\"fastspring_product_name\\\";s:0:\\\"\\\";s:23:\\\"fastspring_product_path\\\";s:10:\\\"te********\\\";s:9:\\\"paypal_id\\\";s:0:\\\"\\\";s:17:\\\"recurly_plan_code\\\";s:0:\\\"\\\";}\",\n \"option1\": null,\n \"option2\": null,\n \"option3\": null,\n \"options\": \"[]\",\n \"tax_rate\": null\n }\n ],\n \"payments\": [\n {\n \"invoice_payment_id\": 3261859,\n \"invoice_id\": \"1738845\",\n \"invoice_public_id\": \"7CMJ5\",\n \"user_id\": \"883051\",\n \"paysys_id\": \"cc-demo\",\n \"receipt_id\": \"123\",\n \"transaction_id\": \"123-m-15427191825876\",\n \"dattm\": \"2018-11-20 17:06:00\",\n \"currency\": \"EUR\",\n \"amount\": \"2.00\",\n \"discount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping\": \"0.00\",\n \"refund_dattm\": null,\n \"base_currency_multi\": \"1.000000\",\n \"display_invoice_id\": \"INV-2018-71\",\n \"refund_amount\": null,\n \"invoice_sequential_id\": null,\n \"tax_rate\": null,\n \"tax_country\": null,\n \"tax_state\": null,\n \"tax_zip\": null,\n \"tax_city\": null,\n \"tax_street\": null,\n \"tax_street2\": null\n }\n ],\n \"refunds\": [],\n \"access\": [\n {\n \"access_id\": 4944648,\n \"invoice_id\": \"1738845\",\n \"invoice_public_id\": \"7CMJ5\",\n \"invoice_payment_id\": \"3261859\",\n \"invoice_item_id\": \"3287810\",\n \"user_id\": \"883051\",\n \"product_id\": \"203\",\n \"transaction_id\": \"123-m-15427191829086\",\n \"begin_date\": \"2018-11-20\",\n \"expire_date\": \"2018-12-20\",\n \"qty\": \"1\",\n \"comment\": null\n }\n ]\n }\n}"},{"id":"f3a7af39-1e13-4136-aade-36f2c86b3b5b","name":"Cancellation error","originalRequest":{"method":"DELETE","header":[],"url":"http://example.com/amember/api2/user/invoice/1738846"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Nov 2018 13:09:53 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"193"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"validation-error\",\n \"message\": \"Unable to cancel invoice #1738846: Transaction was not cancelled. Got error from paypal: Authentication/Authorization Failed\",\n \"hint\": []\n}"}],"_postman_id":"66247e22-e94b-4c4c-8bd5-c7f5a725ddd6"}],"id":"7c9a6e7d-b5a7-48e1-a6f1-44faaf1f0d64","_postman_id":"7c9a6e7d-b5a7-48e1-a6f1-44faaf1f0d64","description":""},{"name":"Manage User's Newsletter Subscriptions","item":[{"name":"/amember/api2/user/newsletter/lists","id":"30ce372b-9d67-4003-b692-312349d75b5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Retrieve all newsletter lists that are available for user.
\nSupported Scopes
\nRetrieve subscribed newsletter lists for user.
\nSupported Scopes
\nSubscribe user to list
\nSupported Scopes
\nUnsubscriber user from list
\nSupported Scopes
\nIf you have newsletter module enabled in amember these endpoints provides and ability to manage user's newsletter subscirptions.
\n","event":[{"listen":"prerequest","script":{"id":"cc830ffe-a55c-4f29-8ae0-872fcc7eff41","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"42f898bf-ff13-4fb6-988c-a9412f323506","type":"text/javascript","exec":[""]}}],"_postman_id":"ae6c1aa7-232e-4d29-9dca-9f34d8872ace"},{"name":"/amember/oauth/register-device","id":"d74bb5ae-7743-4ca9-a65b-f8d8ac185470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"description","value":"Chrome Browser","description":"Device name or title that will be displayed for user/admin interface where list of registered devices will be displayed.
\n","type":"text"},{"key":"client_id","value":"838f5bc4302cf62a15c1f232f902423f","description":"Oauth Client that requested device registration
\n","type":"text"}]},"url":"http://example.com/amember/oauth/register-device","description":"Register device on the server. \nIf Device registration is enabled in module settings, device shoulpd be registered first. Token will not be issued if amember_device_id request is not included in token request.
\n","urlObject":{"protocol":"http","path":["amember","oauth","register-device"],"host":["example","com"],"query":[],"variable":[]}},"response":[{"id":"bd6ba5b1-4cfd-4fe1-8835-4625b741af60","name":"/amember/oauth/register-device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"description","value":"Chrome Browser","description":"Device name or title that will be displayed for user/admin interface where list of registered devices will be displayed. \n","type":"text"},{"key":"client_id","value":"838f5bc4302cf62a15c1f232f902423f","description":"Oauth Client that requested device registration","type":"text"}]},"url":"http://example.com/amember/oauth/register-device"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 12:30:13 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"111"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"amember_device_id\": \"27778a9d770c2f378a6013da715d41ca9af7dc5c9f17548e05aa8315bd10f977\"\n }\n}"}],"_postman_id":"d74bb5ae-7743-4ca9-a65b-f8d8ac185470"},{"name":"/amember/oauth/scope","id":"e2f2eef0-be73-4cdf-8089-ec087c596625","request":{"method":"GET","header":[],"url":"http://localhost/amember/oauth/scope","description":"Retrieve list of all scope objects
\n","urlObject":{"protocol":"http","path":["amember","oauth","scope"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1097587e-7ffb-4964-904b-6106ff5d9ee1","name":"/amember/oauth/scope","originalRequest":{"method":"GET","header":[],"url":"http://localhost/amember/oauth/scope"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 15 Nov 2018 09:38:29 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"me.profile\": {\n \"id\": \"me.profile\",\n \"description\": \"Basic User profile information(login, name, email)\",\n \"grantTypes\": [\n \"password\",\n \"authorization_code\"\n ]\n },\n \"me.fullprofile\": {\n \"id\": \"me.fullprofile\",\n \"description\": \"Full profile information, with address info\",\n \"grantTypes\": [\n \"password\",\n \"authorization_code\"\n ]\n },\n \"me.subscriptions\": {\n \"id\": \"me.subscriptions\",\n \"description\": \"Information about active subscirptions and access expiration dates\",\n \"grantTypes\": [\n \"password\",\n \"authorization_code\"\n ]\n },\n \"me.resources\": {\n \"id\": \"me.resources\",\n \"description\": \"Information about resources available to user on site(protected folders, files, videos)\",\n \"grantTypes\": [\n \"password\",\n \"authorization_code\"\n ]\n },\n \"paysystems\": {\n \"id\": \"paysystems\",\n \"description\": \"Retrieve list of enabled payment systems\",\n \"grantTypes\": [\n \"client_credentials\"\n ]\n },\n \"available-products\": {\n \"id\": \"available-products\",\n \"description\": \"Get products available for purchase\",\n \"grantTypes\": [\n \"authorization_code\",\n \"password\",\n \"client_credentials\"\n ]\n },\n \"register\": {\n \"id\": \"register\",\n \"description\": \"Create user account\",\n \"grantTypes\": [\n \"client_credentials\"\n ]\n },\n \"register.post\": {\n \"id\": \"register.post\",\n \"description\": \"Create user account Method: post\",\n \"grantTypes\": [\n \"client_credentials\"\n ]\n },\n \"user.access\": {\n \"id\": \"user.access\",\n \"description\": \"Get information about access records\",\n \"grantTypes\": [\n \"password\",\n \"authorization_code\"\n ]\n }\n }\n}"}],"_postman_id":"e2f2eef0-be73-4cdf-8089-ec087c596625"},{"name":"/amember/api2/me","id":"9d0d96a2-3bc7-4a58-9798-b015938a42dc","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Required if device registration was enabled in config.
\n","type":"text"}],"url":"http://example.com/amember/api2/me","description":"Get profile information of user
\nSupported Scopes
\nUser's First Name
\n","type":"text"},{"key":"name_l","value":"Ivanov","description":"User's Last Name
\n","type":"text"},{"key":"login","value":"alexander_oauth","description":"Login specified by user
\n","type":"text"},{"key":"email","value":"alexander+oauth@cgi-central.net","description":"User's Email Address.
\n","type":"text"},{"key":"pass","value":"test123","description":"User's password
\n","type":"text"},{"key":"street","value":"Some street","description":"User's address
\n","type":"text"},{"key":"city","value":"Some city","description":"User's city
\n","type":"text"},{"key":"country","value":"US","description":"Two letter ISO country code
\n","type":"text"},{"key":"state","value":"CA","description":"State code
\n","type":"text"},{"key":"zip","value":"1231213","description":"Postal (Zip) code
\n","type":"text"}]},"url":"http://example.com/amember/api2/register","description":"Register User's account. \nIn order to use that endpoint, in aMember CP -> Forms Editor you have to create form with type oauth-register. \naMember will use that form to validate incoming request. All fields that you mark as required will be required in incoming request.
\nPlease note, new user account will be created with \"unsubscribed\" status, so you need to verify user's email address after registration. To send verification email, you can enable email verification in Email brick configuration inside oauth-register form, the same way as you are doing this for regular signup forms. There are two way how user can confirm email address:
\nIn order to use other endpoints after registration you have to obtain new access token using password or authorization_code grant types. \nIf oauth client that was used for registration has \"password\" grant enabled, after registration, amember will issue new access token with grant type set to password with all scopes allowed for client. Check examples.
\nSupported Scopes
\nRetrieve list of available for purchase products. \nList is filtered according to Product Allow/Dissallow requirements, if request is processed on user's behalf
\nSupported Scopes
\n(optional) Filter product list by categories
\n","type":"text/plain"},"key":"categories","value":"CATEGORY_ID"},{"disabled":true,"description":{"content":"(optional) Filter product list by categories
\n","type":"text/plain"},"key":"categories[]","value":"3"}],"variable":[]}},"response":[{"id":"f37fe3a6-8b6e-406d-8a68-63140892a475","name":"/amember/api2/available-products","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://example.com/amember/api2/available-products?categories[]=3","protocol":"http","host":["example","com"],"path":["amember","api2","available-products"],"query":[{"key":"categories[]","value":"3","description":"(optional) Filter product list by categories"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 15 Nov 2018 11:52:07 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"769"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"product_id\": 222,\n \"title\": \"Wheight loss programm\",\n \"description\": \"Short description of this subscription\",\n \"categories\": [\n \"3\"\n ],\n \"billing_plans\": {\n \"222\": \"default - $35.00 untuk 9 bulan\"\n }\n },\n {\n \"product_id\": 223,\n \"title\": \"Bronze Membership\",\n \"description\": \"Short description of this subscription\",\n \"categories\": [\n \"2\",\n \"3\"\n ],\n \"billing_plans\": {\n \"223\": \"default - $129.00 untuk 5 bulan\"\n }\n },\n {\n \"product_id\": 230,\n \"title\": \"Education Course (Middle)\",\n \"description\": \"Short description of this subscription\",\n \"categories\": [\n \"3\"\n ],\n \"billing_plans\": {\n \"230\": \"default - $103.00 untuk 7 bulan\"\n }\n },\n {\n \"product_id\": 235,\n \"title\": \"Training Programm\",\n \"description\": \"Short description of this subscription\",\n \"categories\": [\n \"2\",\n \"3\",\n \"17\",\n \"18\"\n ],\n \"billing_plans\": {\n \"235\": \"default - $112.00 untuk 6 bulan\"\n }\n }\n ]\n}"}],"_postman_id":"e586cfba-6a0a-41e8-8069-1cd103f2aae7"},{"name":"/amember/api2/paysystems","id":"5b44ab1d-01dd-4a89-b1ba-aba0d1f1eeb8","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of all enabled payment systems.
\npassword, authorization_code, client_credentials, amember_device\nSupported scopes
\nClient should send Authorization header with access token in each request:
\nAuthorization: Bearer ACCESS_TOKEN\n2xx means successful response code.\n4xx user error\n5xx system error\nResponse Content type is application/json
\n{\n status : 'OK',\n data : {\n # Requested object or list of objects\n }\n}\n{\n status : 'error',\n error : 'short error code',\n message : 'Error description',\n hint : 'Additional information if applicable'\n \n}\n