Neucron
Search
⌃K
Comment on page

Swagger

This page describes the process to call API endpoints from the swagger UI and testing and development purposes
  1. 1.
    Go to the Neucron Swagger UI​
  2. 2.
    Scroll to the "Auth" section to find the /auth/signup API inside it
  3. 3.
    Click on it to open it and it will look like the below image
  1. 4.
    Click "Try it out" to use the signup API
Sign Up Swagger
  1. 5.
    Enter your email and password by replacing the "string" value with your own email and password
  2. 6.
    Click the "EXECUTE" button in blue
  3. 7.
    Your account would be created with your email along with a default wallet set up for you. The image below shows a sample response. This response shows your
    1. 1.
      userid used to identify you uniquely
    2. 2.
      `walletid` for the default wallet created for you
    3. 3.
      wallet-address for a bitcoin address of that wallet
    4. 4.
      `public key` for a bitcoin public key of that wallet
    5. 5.
      `access token` used to authorize yourself for calling the protected endpoints
Response on calling Signup
  1. 8.
    Copy the access_token and scroll up to the top part of the page where the Authorize button is clicked as shown below
Authorize
Authorize Popup
​
  1. 9.
    Paste the Access Token that you had copied, in the box here
  2. 10.
    Click Authorize
Authorize
Close Authorize Popup
  1. 11.
    You will now be able to use any protected API which has a lock at the end of it
Transaction API
  1. 12.
    If you have already signed up before, then you can login using auth/login which returns the `access_token` which can be used to Authorize the same way again.
Happy Coding!
Previous
Introduction
Next
Auth
Last modified 3mo ago