api-docs.smartcollect.software Open in urlscan Pro
172.67.201.135  Public Scan

URL: https://api-docs.smartcollect.software/
Submission: On June 11 via api from US — Scanned from DE

Form analysis 1 forms found in the DOM

<form class="download-url-wrapper"><input class="download-url-input" type="text" id="download-url-input" value="./api_docs.yaml"><button class="download-url-button button">Explore</button></form>

Text Content

Explore


SMARTCOLLECT API DOCUMENTATION

 v1 

OAS 3.0

./api_docs.yaml
 * Welcome to SmartCollect API Documentation
 * Creating an API Token requires you to login to your SmartCollect account
 * After successful login, in the menu, go to Integration->API Tokens and
   generate a new API token.
 * Copy the token generated and keep it safe for your use. You won’t be able to
   access the token again unless you generate a new one.
 * You should specify the access token you generated as a Bearer token in the
   Authorization header of your request.
 * Include Accept = application/json in the header of your request.

Universal HTTP Status codes that APIs may return

Status CodeDescriptionReason 200SUCCESSIf request was executed successfully.
400BAD REQUESTIf the request is not valid. 401UNAUTHORIZEDIf no/invalid Token is
provided. 500SERVER_ERRORIf SmartCollect collect experienced an error

Servers
https://{smartcollect_url}/api/v1
Computed URL:https://sandbox.smartcollect.software/api/v1

SERVER VARIABLES

smartcollect_url

Authorize



HEALTH CHECK

GET
/healthz
Check the status of the API



FILES

POST
/files
Posting new Files



PAYMENTS

POST
/payments
Post Payments



COLLECTION UPDATES

GET
/collection-updates
Fetch Collection Updates


SCHEMAS

File
Payment
CollectionUpdate