Documentation and examples for using the Contracting.Works client API

Under heavy construction

This repository contains various resources for implementing integration with Contracting.Works, including:

• Getting started with Contracting.Works integration guide
• Data Model overview & principles
• Authentication / authorization
  • Devinco.Connect service
  • Getting test users etc.
• ClientApi (REST) API principles and examples
  • Limitations
  • Extensions
  • Link to Swagger / OpenAPI specification for externally available test environment
  • Dealing with authorization & client data access
  • Delta updates / null handling
  • Batch handling
• GraphQL API principles and examples
  • Limitations / adaptations (no mutations or subscriptions, simplified variant of edges / nodes)
  • Extensions (filter expressions / paths)
  • Paging
  • Error types and handling
  • Link to Banana Cake Pop for externally available test environment
  • Dealing with authorization & client data access
• Reference guide
  • Date handling
  • Error types and handling
• System Architecture
• Integration Architecture