{"items":[{"type":"link","label":"Auth APIs","link":"/openapi/auth","routeSlug":"/openapi/auth","content":{"contentType":"overview","meta":{"name":"Auth APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"auth.json","url":"/_bundle/openapi/auth.json?download"},{"kind":"download","label":"auth.yaml","url":"/_bundle/openapi/auth.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/auth","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/auth","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/auth","description":"Sandbox Server for Canada"},{"url":"https://api.sendpro360.pitneybowes.com/ca/auth","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Auth APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is the API to manage credentials and generate token"}],"sectionId":"/openapi/auth"}],"sectionId":"/openapi/auth"}]}]}},{"label":"Get Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/auth/other/getaccesstoken","routeSlug":"/openapi/auth/other/getaccesstoken","metadata":{"seo":{"title":"Get Access Token","description":"Each request to the Shipping 360 API requires authentication via an OAuth token. This API call generates the OAuth token based on the Base64-encoded value of the Client ID and Secret associated with your developer account. The token expires after 4 hours. Client ID is the The unique identifier assigned to the client application and Secret is a confidential string used to authenticate the client. These both are required to generate token. Use Client ID as User Name and Secret as Password for getting access token while trying out in security options."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccessToken","name":"Get Access Token","isWebhook":false,"pointer":"/paths/~1api~1v1~1token/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Access Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request to the Shipping 360 API requires authentication via an OAuth token. This API call generates the OAuth token based on the Base64-encoded value of the Client ID and Secret associated with your developer account. The token expires after 4 hours. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the The unique identifier assigned to the client application and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a confidential string used to authenticate the client. These both are required to generate token. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as User Name and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as Password for getting access token while trying out in security options."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_234","required":true,"example":"application/json"}],"pointer":"/paths/~1api~1v1~1token/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/token","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/auth","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/auth","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/auth","description":"Sandbox Server for Canada"},{"url":"https://api.sendpro360.pitneybowes.com/ca/auth","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_234"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/token","href":"other/getaccesstoken","openApiOperationId":"getAccessToken","summary":"Get Access Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/auth","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/auth","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/auth","description":"Sandbox Server for Canada"},{"url":"https://api.sendpro360.pitneybowes.com/ca/auth","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The token has been generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235","exampleIds":["paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_235","exampleIds":["paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response"]},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1api~1v1~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_235","exampleIds":["paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235","exampleIds":["paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getaccesstoken"}],"panels":[]}]},"httpPath":"/api/v1/token"}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"errorCode":{"type":"string"},"errorSummary":{"type":"string"},"errorLink":{"type":"string"},"errorId":{"type":"string"},"errorCauses":{"type":"array","items":{"type":"string"}}},"required":["message","code"]}},"schema_234":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"object","properties":{"access_token":{"type":"string","example":"token"},"expires_in":{"type":"number","example":14400},"scope":{"type":"string","example":"psapi"},"token_type":{"type":"string","example":"Bearer"}}},"id":"schema_235"}},"exampleStore":{"paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response":{"value":{"access_token":"token","expires_in":14400,"scope":"psapi","token_type":"Bearer"},"key":"response","summary":"response","id":"paths/~1api~1v1~1token/post/responses/200/content/application~1json/examples/response"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/auth","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/auth","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/auth","description":"Sandbox Server for Canada"},{"url":"https://api.sendpro360.pitneybowes.com/ca/auth","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/auth.json?download"},{"url":"/_bundle/openapi/auth.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Auth APIs","description":"This is the API to manage credentials and generate token"}},"baseSlug":"/openapi/auth","routesMapping":{}}