Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds Authentication page content #48

Merged
merged 2 commits into from
Oct 18, 2024
Merged

adds Authentication page content #48

merged 2 commits into from
Oct 18, 2024

Conversation

jeanmartin
Copy link
Member

No description provided.

With the private key file and app ID, you have full access to all API functions for your app, including managing
Gigs, Users, and other app settings.

Read more about how to use the private key file and app ID in the [API authentication documentation](https://cirroapiv2.docs.apiary.io/#introduction/authentication).
Copy link

@secretanna secretanna Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have auth info on our new API docs page link

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@secretanna Is the new API docs page already complete enough for us to link only to it going forward, or is there still too much missing?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it (authentication page) has all the content from apiary

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page looks good indeed and is detailed enough

Once you have registered your app, you will receive your **app ID**.
You then need to generate your apps **private key file** (PEM format).
The developer portal allows you to generate this file and download it.
The private key file is used to sign the JWT token that is sent with each API request.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably add code to generate the JWT token in ruby or any pseudo code, so this way there is no ambiguity for the user

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That code is already on the linked API documentation page. I wouldn't copy it here, since this is not a technical documentation.

@jeanmartin jeanmartin merged commit 6bf191c into main Oct 18, 2024
4 checks passed
@jeanmartin jeanmartin deleted the page/authentication branch October 18, 2024 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants