Enhancement: Update Authentication Page for Chimoney API Documentation

phyleria commented 2 months ago

Description

We need an updated detailed Authentication page that explains how to authenticate requests to the Chimoney API.

Current Page This updated page should cover:

API Key Authentication: Provide clear instructions on how to use API keys to authenticate requests, including proper use of the Authorization header.
Security Best Practices: Highlight important security tips like storing API keys in environment variables, keeping keys secret, and rotating them periodically.
Error Handling: Explain the common authentication-related errors (e.g., 401 Unauthorized) and how to resolve them.
Example Requests: Include example curl commands or code snippets showing how to authenticate API requests.
Response Format: Show sample responses for both successful authentication and common authentication errors.

Acceptance Criteria:

The page must provide a clear, concise explanation of API authentication.
Include at least one example of an authenticated API request (using curl or another tool).
Highlight security best practices and error handling.
Ensure all technical terms are well-explained, and links to further documentation are provided.

Screenshots

No response

Additional Information

No response

Ready to Work?

[ ] I want to work on this enhancement

ayan-joshi commented 2 months ago

Hey @phyleria , I want to work on this enhancement and I'm ensuring of a better result too. Thanks for your time !

phyleria commented 2 months ago

Ok, I am assigning it to you right now

phyleria commented 1 month ago

Hi @ayan-joshi

Will you still be able to work on this?

oluwatobi2001 commented 1 month ago

Hi I am interested in working on this. Thank you

ayan-joshi commented 1 month ago

Hi @ayan-joshi

Will you still be able to work on this?

@phyleria Yes I just wanted to know where in the folder this need to be edited and change ?

ayan-joshi commented 1 month ago

@phyleria Hey , as it says we need to update the authentication page , where I can find the previous page code as it will be with you on private repo , so may I write a whole new page then?

ayan-joshi commented 1 month ago

@phyleria Hey , as it says we need to update the authentication page , where I can find the previous page code as it will be with you on private repo , so may I write a whole new page then?

@phyleria have a look at this please

phyleria commented 1 month ago

Hi @ayan-joshi,

The API docs ReadMe isn't currently open to contributors. Could you kindly create a new markdown file with the current contents of the Authentication page, including your updates and submission? Once done, please submit it within the articles folder.

Does this sound clear? Let me know if you need any further clarification—happy to help!

ayan-joshi commented 1 month ago

Hi @ayan-joshi,

The API docs ReadMe isn't currently open to contributors. Could you kindly create a new markdown file with the current contents of the Authentication page, including your updates and submission? Once done, please submit it within the articles folder.

Does this sound clear? Let me know if you need any further clarification—happy to help!

Okay thanks , I'll follow this @phyleria

ayan-joshi commented 1 month ago

@phyleria quite busy with college , sorry for the delay I'll complete this and open the pr in the next week as early as possible

phyleria commented 1 month ago

ok @ayan-joshi ✅

Chimoney / chimoney-community-projects