commons/server

Commons: Server

This folder contains server component written in TypeScript using Express. The server provides various microservices.

• Get Started
• ✨ API Documentation
  • Url Checker
  • Report
• 🎁 Contributing
• 🏛 License

Get Started

To spin up the server in a watch mode for local development, execute:

npm install
npm start

✨ API Documentation

Url Checker

Url Checker returns size and additional information about requested file. This service is used as a solution to frontend CORS restrictions.

Endpoint: POST /api/v1/urlcheck

Request Parameters

{
  "url": "https://oceanprotocol.com/tech-whitepaper.pdf"
}

{
  "url": "ipfs://QmQfpdcMWnLTXKKW9GPV7NgtEugghgD6HgzSF6gSrp2mL9"
}

Response: Success

{
  "status": "success",
  "result": {
    "found": true,
    "contentLength": "2989228",
    "contentType": "application/pdf"
  }
}

Response: Error

{
  "status": "error",
  "message": null
}

Report

Report endpoints sends an email via SendGrid. Requires SENDGRID_API_KEY set as environment variables.

Endpoint: POST /api/v1/report

Request Parameters

{
  "msg": {
    "to": "test@example.com",
    "from": "test@example.com",
    "subject": "My Subject",
    "text": "Text",
    "html": "<strong>HTML</strong>"
  }
}

Response: Success

{
  "status": "success"
}

Response: Error

{
  "status": "error",
  "message": "Error message"
}

🎁 Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

🏛 License

Copyright 2019 Ocean Protocol Foundation Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.