cryptoworxx/cnovation-pay

Client lib to access the c-novation-pay.com API

0.0.3 2019-05-21 13:56 UTC

This package is auto-updated.

Last update: 2024-05-09 20:11:24 UTC


README

This is the repository for the official CNovation-Pay API.
We plan to provide clients for different languages, for now starting with PHP. There are also some plugins for well-known shop systems we will maintain. Feel free to implement your own or contact us if you want a specific system connected.

Installation

API client is supposed to be usable as include only, so feel free to grab a copy and add it to your source code.
Additionally we support installation via composer (for PHP):

composer require cryptoworxx/cnovation-pay

Ready-to-use plugins can be found in the releases section.

Documentation

Find the API Reference over here.

Security and Authentication

The CNovation-Pay API uses SSL and only SSL to secure every request. Every request needs a token argument to be accepted, API Token can be generated in the CNovation-Pay portal or using the APIs Auth interface. Token can be unrecoverably deleted in your portal account at any time, so misuse can be effectifely blocked. API Token can optionally be registered for a specific system, so that they are only usable with an additional password.

Plugins

We provide plugins for some well-known shop system, and we plan to add some more too. Check the releases page for current state of work.
These plugins are ready to use:

These Plugins are installable via composer

These are in planning:

Concepts

Basically there are two ways of embedding the CNovation-pay API in your system:

  • Use the API default user-interface
  • Use the API to integrate in your own user-interface

For a sample of a complete integration see the Shopware plugin we maintain, for a default-UI see the WooCommerce plugin.