Documentation

API Documentation

Overview

This API allows users to authenticate and retrieve company valuations. Authentication is required to access the valuation data.

Authentication

Endpoint: /api/auth/signinExt

• Method: POST
• Description: Authenticate the user and receive a token for accessing other API methods.
• Request Body:

            {
              "email": "yourEmail",
              "password": "yourPassword"
            }
      

• Response:

            {
              "yourAccessToken"
            }
      

• Example Request:

      curl -X POST https://mval.m2mcapital.com/api/auth/signinExt \
        -H "Content-Type: application/json" \
        -d '{"email": "yourEmail", "password": "yourPassword"}'
      

Get Company Valuations

Endpoint: api/GetCompanyValuations

• Method: GET
• Description: Retrieve valuations for companies the user has access to based on their current plan.
• Headers:
• Authorization: Bearer yourAccessToken
• Optional Query Parameters:
• companyName (string): The name of the company for which to get the valuation.
• Behavior:
• Without parameters: Returns valuations for all companies the user has access to, as recent as allowed by their current plan.
• With companyName: Returns the valuation for the specified company, as recent as allowed by their current plan.
• Response:
• Success:

            {
              "companyName": "CompanyName",
              "address": "CompanyAddress",
              "industry": "Industry",
              "subIndustry": "SubIndustry",
              "website": "http://companywebsite.com",
              "sharePrice": 14.56,
              "date": "YYYY-MM-DD"
            }
          

• Error:

            {
              "error": "Valuation not found."
            }
          

• Example Request:

      curl -X GET https://mval.m2mcapital.com/api/GetCompanyValuations \
        -H "Authorization: Bearer yourAccessToken"
      

With companyName and date parameters:

      curl -X GET "https://mval.m2mcapital.com/api/GetCompanyValuations/CompanyName" \
        -H "Authorization: Bearer yourAccessToken"
      

Error Handling

• Invalid Credentials:
• Response:

          {
            "error": "Invalid username or password"
          }
      

• Unauthorized Access:
• Response:

          {
            "error": "Unauthorized access. Please provide a valid token."
          }
      

• Date Out of Range:
• Response:

          {
            "error": "The specified date is outside the range allowed by your current plan."
          }
      

• Company Not Found:
• Response:

          {
            "error": "Company not found. The company does not exist, or you do not have access to it."
          }