Write API documentation

[retrixe]

Some initial work has started in API.md for now, but documentation is far from complete.

• Document reverse proxying and security practices to follow with Octyne.
• Complete documenting all endpoints with parameters and responses.
• Document possible error responses.

[chaneth8]

Hi, I'd love to help with this issue but I'm having some problems getting your APIs to run.

What I've done so far is to move config.json and users.json into the same directory as main.go. I then ran the following in the terminal:

The errors I got were:

command-line-arguments

./main.go:17:22: undefined: Config
./main.go:36:13: undefined: Config
./main.go:55:15: undefined: InitializeConnector
./main.go:61:6: undefined: CreateProcess

I'm wondering how to resolve these errors, so that the code will run?

Thanks so much!

[retrixe]

@chaneth8 it should run correctly with go run .

go run main.go will only compile main.go and ignore all the other Go files.

Alternatively, you can use any of the uploaded binaries on the releases page instead if you don't want to run from source.

[chaneth8]

@retrixe Thank you for getting back. Is it okay if I ask a few more questions?

I'm trying to test the API on postman to get an idea of what it outputs for each endpoint. But I'm running into some trouble getting the authentication token. When I ran the following, I got:

Do I need to be running an app with octyne in order to log in? If so, how do I do that?

Or do I need to edit users.json? This is what I have currently:

Thanks.

[Sanguineous1]

@chaneth8 You are passing the login details through query parameters, you need to pass them through headers as Username and Password for logging in.

Also for users.json yes you do need to modify it, replace username with your username of choice and the password with a SHA256 hash, you can convert your password to a hash at https://sha256.vercel.app/

[retrixe]

Complete with 1.2.0, documenting potential API errors is too much for now.