NINJAHIRE API Documentation

Welcome to the documentation for our API. This page serves as an index to help you navigate through the available endpoints and their functionalities.

Authentication

Before making requests to the API endpoints, you may need to authenticate. Here are the authentication methods supported:

• API Key: Include your API key in the request headers using the Authorization header.

Endpoints

Jobs

• GET /jobs

  • Description: Retrieve a list of all available jobs.
  • Parameters:
    • page (optional): The page number of results to retrieve.
    • limit (optional): The maximum number of jobs per page.
  • Example Request:

    GET /jobs?page=1&limit=10
    

  • Example Response:

    [
        {
            "id": 1,
            "title": "Software Engineer",
            "description": "Develop software applications using various programming languages."
        },
        {
            "id": 2,
            "title": "Data Scientist",
            "description": "Analyze and interpret complex data sets to provide actionable insights."
        }
    ]
    

• GET /jobs/{id}

  • Description: Retrieve details of a specific job by ID.
  • Parameters:
    • id (required): The ID of the job to retrieve.
  • Example Request:

    GET /jobs/1
    

  • Example Response:

    {
        "id": 1,
        "title": "Software Engineer",
        "description": "Develop software applications using various programming languages."
    }
    

Applications

• POST /jobs/{id}/apply
  • Description: Apply for a job by ID.
  • Parameters:
    • id (required): The ID of the job to apply for.
    • name (required): The applicant's name.
    • email (required): The applicant's email address.
    • resume (required): The applicant's resume file.
  • Example Request:

    POST /jobs/1/apply
    Content-Type: application/json
    
    {
        "name": "John Doe",
        "email": "john@example.com",
        "resume": "path/to/resume.pdf"
    }
    

  • Example Response:

    {
        "message": "Application submitted successfully."
    }
    

Rate Limiting

Our API enforces rate limiting to ensure fair usage. You may encounter HTTP 429 Too Many Requests responses if you exceed the rate limit. Contact support for increased rate limits.

Support

If you have any questions or need assistance, please contact our support team at support@example.com.