LogoLogo
  • Notify API Overview
  • Security
  • Authentication
  • Testing
  • API overview
  • Information
    • Handling errors
    • Data details
    • Pagination
    • Country codes
    • Languages
  • Customers
    • List customers
    • Get customer
    • Search customer
    • Create customer
    • Update customer
    • Delete customer
  • Invoices
    • List invoices
    • Get invoice
    • Create invoice
    • Update invoice
    • Delete invoice
  • Documents
    • Create document
    • Delete document
    • Upload by FTP
    • Upload by e-mail
  • Payments
    • List payments
    • Create payment
Powered by GitBook
On this page

Was this helpful?

Export as PDF

Notify API Overview

NextSecurity

Last updated 3 years ago

Was this helpful?

Use the Notify API to send invoice, customer and payment information to the Notify platform. Notify and your app back-end will communicate by sending HTTP requests back and forth.

This page provides an overview of the Notify API. The topics in the chapter deal with a number of specific aspects of the API. We recommend to read these topics entirely.

If you have any questions about integrating our API, please contact us. We are happy to help!

The Notify REST API

The API implements a Representational state transfer (REST) architecture. Sounds technical, but it’s really quite easy. It mainly breaks down to HTTP-methods GET, PATCH, POST and DELETE matching the operations to read, update, create and delete.

REST also implies a nice and clean structure for URLs or endpoints. This means you can reach any part of the Notify API on https://api.notify.cm/v2/ adding the name of the resource you want to interact with.

Security
Authentication
API overview