coin-sdk

Release 1.4.0

SDKs for Vereninging COIN's apis

Homepage PyPI

Keywords
COIN, Numberportability, TELECOM, SDK
License
Apache-2.0
Install
pip install coin-sdk==1.4.0

Documentation

COIN REST APIs

Introduction

The COIN RESTful APIs serve as modern replacements for the outdated MQ and SOAP interfaces. This new approach consists of highly secure yet quick and easy to implement web-standards thereby avoiding additional middleware for API users.

In order to ease the introduce to the new APIs for new users, Vereniging COIN offers SDKs in several programming languages.

For a quick start, follow the steps below:

Configure Credentials

Generate Keys

In order to be able to use a COIN API, the user is required to have a private/public key pair. Execute the following commands:

ssh-keygen -m PEM -t rsa -b 4096 -f private-key.pem -N '' 
ssh-keygen -e -m PKCS8 -f private-key.pem > public-key.pem

For Windows users, please note that running the commands in git-bash is required:

ssh-keygen.exe -m PEM -t rsa -b 4096 -f private-key.pem -N ''
ssh-keygen.exe -e -m PKCS8 -f private-key.pem > public-key.pem

These scripts generate the private and public keys: public-key.pem and private-key.pem.

Store keys in COIN's IAM (Identity and Access Manager)

  • Go to: https://test-portal.coin.nl/iam#/

    • Access to this site requires a user account that can be requested at Coin Servicedesk

  • Select consumer name alt text

  • Configure IP Addresses and add public key alt text

  • Press save alt text

  • Retrieve client credentials

    • Copy the contents of the Encrypted hmac secret field and place it into a file named: sharedkey.encrypted. alt text

Once the public key has been registered, the following private and public keys are needed to gain secured access to COIN APIs:

  • consumer name (see above)
  • private-key.pem (see above)
  • sharedkey.encrypted encrypted HMAC secret (see above)

Choose an API

Python SDKs for the APIs

  • The Python SDK documentation for the Number Portability API can be found here

Additional Resources

COIN APIs

Support

If you need support, feel free to send an email to the Coin devops team.

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
17
Latest release
First release
Stars
0
Forks
1
Contributors
0
SourceRank
8

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

1.4.0
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.5
1.0.4
1.0.3
1.0.1
See all 17 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-02-03 19:34:11 UTC

Login to resync this project