Integrate
Integrate v2
Integrate v1Integrate v2
Integrate v2
Integrate v1Integrate v2
  • Getting Started
    • 🤝Authorisation & Activation
    • 🔗API v2 URL
    • 🔢Versioning
    • 🔐Authentication
    • 🆗Response Status Codes
    • 🛑Rate Limiting
    • ⁉️Errors and Bad Requests
    • ⏭️Upgrading to v2
  • Reference
    • Settings
      • Client Integrations
        • Get Client Integrations
        • Change Client Integration State
    • Finance+
      • Debt Management
        • Debtor Notes
          • Get Communication Type(s)
          • Get Note Type(s)
          • Get Note(s)
          • Create Note
          • Update Note
          • Delete Note
          • Get Promise To Pay Record(s)
          • Delete Promise To Pay
        • Age Analysis Report
        • Financial Transactions Report
        • Get Schools
        • Get Accountable Person(s)
        • Get Learner(s)
        • Get Transaction Type(s)
        • Get Transaction Category(s)
Powered by GitBook
On this page
  1. Getting Started

Authentication

d6 Integrate requires authentication via username and password credentials which are provided to you by d6 after successful completion of a data sharing license agreement.

The credentials must be passed in the request header using the following parameters:

HTTP-X-USERNAME

HTTP-X-PASSWORD

All API requests must be made over HTTPS. Requests made over plain HTTP will fail and may risk exposing your key. Your credentials must never be shared. Do not use your credentials in client side code as you may risk exposing it to third parties.

PreviousVersioningNextResponse Status Codes
🔐